Table Of Contents

Feedback

User Guide

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

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

list-text-translation-jobs

Description

Gets a list of the batch translation jobs that you have submitted.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-text-translation-jobs
[--filter <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--filter (structure)

The parameters that specify which batch translation jobs to retrieve. Filters include job name, job status, and submission time. You can only set one filter at a time.

JobName -> (string)

Filters the list of jobs by name.

JobStatus -> (string)

Filters the list of jobs based by job status.

SubmittedBeforeTime -> (timestamp)

Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

SubmittedAfterTime -> (timestamp)

Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

Shorthand Syntax:

JobName=string,JobStatus=string,SubmittedBeforeTime=timestamp,SubmittedAfterTime=timestamp

JSON Syntax:

{
  "JobName": "string",
  "JobStatus": "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"COMPLETED_WITH_ERROR"|"FAILED"|"STOP_REQUESTED"|"STOPPED",
  "SubmittedBeforeTime": timestamp,
  "SubmittedAfterTime": timestamp
}

--next-token (string)

The token to request the next page of results.

--max-results (integer)

The maximum number of results to return in each page. The default value is 100.

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

TextTranslationJobPropertiesList -> (list)

A list containing the properties of each job that is returned.

(structure)

Provides information about a translation job.

JobId -> (string)

The ID of the translation job.

JobName -> (string)

The user-defined name of the translation job.

JobStatus -> (string)

The status of the translation job.

JobDetails -> (structure)

The number of documents successfully and unsuccessfully processed during the translation job.

TranslatedDocumentsCount -> (integer)

The number of documents successfully processed during a translation job.

DocumentsWithErrorsCount -> (integer)

The number of documents that could not be processed during a translation job.

InputDocumentsCount -> (integer)

The number of documents used as input in a translation job.

SourceLanguageCode -> (string)

The language code of the language of the source text. The language must be a language supported by Amazon Translate.

TargetLanguageCodes -> (list)

The language code of the language of the target text. The language must be a language supported by Amazon Translate.

(string)

TerminologyNames -> (list)

A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.

(string)

Message -> (string)

An explanation of any errors that may have occured during the translation job.

SubmittedTime -> (timestamp)

The time at which the translation job was submitted.

EndTime -> (timestamp)

The time at which the translation job ended.

InputDataConfig -> (structure)

The input configuration properties that were specified when the job was requested.

S3Uri -> (string)

The URI of the AWS S3 folder that contains the input file. The folder must be in the same Region as the API endpoint you are calling.

ContentType -> (string)

Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:

  • text/html : The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
  • text/plain : The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document : The input data consists of one or more Word documents (.docx).
  • application/vnd.openxmlformats-officedocument.presentationml.presentation : The input data consists of one or more PowerPoint Presentation files (.pptx).
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet : The input data consists of one or more Excel Workbook files (.xlsx).

Warning

If you structure your input data as HTML, ensure that you set this parameter to text/html . By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain , your costs will cover the translation of every character.

OutputDataConfig -> (structure)

The output configuration properties that were specified when the job was requested.

S3Uri -> (string)

The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.

DataAccessRoleArn -> (string)

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.

NextToken -> (string)

The token to use to retreive the next page of results. This value is null when there are no more results to return.