[ aws . translate ]

start-text-translation-job

Description

Starts an asynchronous batch translation job. Batch translation jobs can be used to translate large volumes of text across multiple documents at once. For more information, see async .

Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.

Note

Amazon Translate does not support batch translation of multiple source languages at once.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  start-text-translation-job
[--job-name <value>]
--input-data-config <value>
--output-data-config <value>
--data-access-role-arn <value>
--source-language-code <value>
--target-language-codes <value>
[--terminology-names <value>]
[--parallel-data-names <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--job-name (string)

The name of the batch translation job to be performed.

--input-data-config (structure)

Specifies the format and S3 location of the input documents for the translation job.

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.

Shorthand Syntax:

S3Uri=string,ContentType=string

JSON Syntax:

{
  "S3Uri": "string",
  "ContentType": "string"
}

--output-data-config (structure)

Specifies the S3 folder to which your job output will be saved.

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.

Shorthand Syntax:

S3Uri=string

JSON Syntax:

{
  "S3Uri": "string"
}

--data-access-role-arn (string)

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more nformation, see identity-and-access-management .

--source-language-code (string)

The language code of the input language. For a list of language codes, see what-is-languages .

Amazon Translate does not automatically detect a source language during batch translation jobs.

--target-language-codes (list)

The language code of the output language.

(string)

Syntax:

"string" "string" ...

--terminology-names (list)

The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.

(string)

Syntax:

"string" "string" ...

--parallel-data-names (list)

The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.

(string)

Syntax:

"string" "string" ...

--client-token (string)

A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.

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

JobId -> (string)

The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.

JobStatus -> (string)

The status of the job. Possible values include:

• SUBMITTED - The job has been received and is queued for processing.

• IN_PROGRESS - Amazon Translate is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job’s output.

• FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob operation.

• STOP_REQUESTED - The user who started the job has requested that it be stopped.

• STOPPED - The job has been stopped.