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 ]

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

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>]
[--settings <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--job-name (string)

The name of the batch translation job to be performed.

--input-data-config (structure)

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

S3Uri -> (string)

The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the folder. The folder must be in the same Region as the API endpoint you are calling.

Note

The URI can also point to a single input document, or it can provide the prefix for a collection of input documents. For example. if you use the URI S3://bucketName/prefix and the prefix is a single file, Amazon Translate uses that files as input. If more than one file begins with the prefix, Amazon Translate uses all of them as input.

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).
  • application/x-xliff+xml : The input data consists of one or more XML Localization Interchange File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.

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.

EncryptionKey -> (structure)

The encryption key used to encrypt this object.

Type -> (string)

The type of encryption key used by Amazon Translate to encrypt this object.

Id -> (string)

The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.

Shorthand Syntax:

S3Uri=string,EncryptionKey={Type=string,Id=string}

JSON Syntax:

{
  "S3Uri": "string",
  "EncryptionKey": {
    "Type": "KMS",
    "Id": "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 information, 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 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.

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

For more information, see how-custom-terminology .

(string)

Syntax:

"string" "string" ...

--parallel-data-names (list)

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. When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

Note

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

For more information, see customizing-translations-parallel-data .

(string)

Syntax:

"string" "string" ...

--client-token (string)

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

--settings (structure)

Settings to configure your translation output, including the option to mask profane words and phrases. StartTextTranslationJob does not support the formality setting.

Formality -> (string)

You can optionally specify the desired level of formality for real-time translations to supported target languages. The formality setting controls the level of formal language usage (also known as register ) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

Note that asynchronous translation jobs don't support formality. If you provide a value for formality, the StartTextTranslationJob API throws an exception (InvalidRequestException).

For target languages that support formality, see Supported Languages and Language Codes in the Amazon Translate Developer Guide .

Profanity -> (string)

Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate doesn't detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide .

Shorthand Syntax:

Formality=string,Profanity=string

JSON Syntax:

{
  "Formality": "FORMAL"|"INFORMAL",
  "Profanity": "MASK"
}

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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.