Skip to content

Start Text Translation Job

translate_start_text_translation_job R Documentation

Starts an asynchronous batch translation job

Description

Starts an asynchronous batch translation job. Use batch translation jobs to translate large volumes of text across multiple documents at once. For batch translation, you can input documents with different source languages (specify auto as the source language). You can specify one or more target languages. Batch translation translates each input document into each of the target languages. For more information, see Asynchronous batch processing.

Batch translation jobs can be described with the describe_text_translation_job operation, listed with the list_text_translation_jobs operation, and stopped with the stop_text_translation_job operation.

Usage

translate_start_text_translation_job(JobName, InputDataConfig,
  OutputDataConfig, DataAccessRoleArn, SourceLanguageCode,
  TargetLanguageCodes, TerminologyNames, ParallelDataNames, ClientToken,
  Settings)

Arguments

JobName

The name of the batch translation job to be performed.

InputDataConfig

[required] Specifies the format and location of the input documents for the translation job.

OutputDataConfig

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

DataAccessRoleArn

[required] 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 information, see Identity and access management .

SourceLanguageCode

[required] The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto. Amazon Translate auto detects the source language for each input document. For a list of supported language codes, see Supported languages.

TargetLanguageCodes

[required] The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.

Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.

TerminologyNames

The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.

For a list of available custom terminology resources, use the list_terminologies operation.

For more information, see Custom terminology.

ParallelDataNames

The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.

When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the list_parallel_data operation.

For more information, see Customizing your translations with parallel data.

ClientToken

[required] A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.

Settings

Settings to configure your translation output. You can configure the following options:

  • Brevity: not supported.

  • Formality: sets the formality level of the output text.

  • Profanity: masks profane words and phrases in your translation output.

Value

A list with the following syntax: 

list(
  JobId = "string",
  JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"COMPLETED_WITH_ERROR"|"FAILED"|"STOP_REQUESTED"|"STOPPED"
)

Request syntax

svc$start_text_translation_job(
  JobName = "string",
  InputDataConfig = list(
    S3Uri = "string",
    ContentType = "string"
  ),
  OutputDataConfig = list(
    S3Uri = "string",
    EncryptionKey = list(
      Type = "KMS",
      Id = "string"
    )
  ),
  DataAccessRoleArn = "string",
  SourceLanguageCode = "string",
  TargetLanguageCodes = list(
    "string"
  ),
  TerminologyNames = list(
    "string"
  ),
  ParallelDataNames = list(
    "string"
  ),
  ClientToken = "string",
  Settings = list(
    Formality = "FORMAL"|"INFORMAL",
    Profanity = "MASK",
    Brevity = "ON"
  )
)