[ aws . translate ]

describe-text-translation-job

Description

Gets the properties associated with an asycnhronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-text-translation-job
--job-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--job-id (string)

The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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

TextTranslationJobProperties -> (structure)

An object that contains the properties associated with an asynchronous batch 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)

ParallelDataNames -> (list)

A list containing the names of the parallel data resources applied to the translation job.

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