/

The Amazon Translate multi-region endpoint

POST

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://translate.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "JobName": "string",
    "InputDataConfig": {
        "S3Uri": "string",
        "ContentType": "string"
    },
    "OutputDataConfig": {
        "S3Uri": "string"
    },
    "DataAccessRoleArn": "string",
    "SourceLanguageCode": "string",
    "TargetLanguageCodes": [],
    "TerminologyNames": [],
    "ParallelDataNames": [],
    "ClientToken": "string"
}'

Response Example

200 - Example 1

{
  "JobId": "string",
  "JobStatus": "SUBMITTED"
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

JobName

string

optional

The name of the batch translation job to be performed.

>= 1 characters<= 256 characters

Match pattern:

^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

InputDataConfig

object

required

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

S3Uri

string

required

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.

<= 1024 characters

Match pattern:

s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

ContentType

string

required

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

<= 256 characters

Match pattern:

^[-\w.]+\/[-\w.+]+$

OutputDataConfig

object

required

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

S3Uri

string

required

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.

<= 1024 characters

Match pattern:

s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

DataAccessRoleArn

string

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 nformation, see identity-and-access-management.

>= 20 characters<= 2048 characters

Match pattern:

arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

SourceLanguageCode

string

required

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.

>= 2 characters<= 5 characters

TargetLanguageCodes

array[string]

required

The language code of the output language.

>= 1 items<= 1 items

TerminologyNames

array[string]

optional

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

ParallelDataNames

array[string]

optional

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.

ClientToken

string

required

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

>= 1 characters<= 64 characters

Match pattern:

^[a-zA-Z0-9-]+$

Examples

Responses

🟢200Success

application/json

Body

JobId

string

optional

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

>= 1 characters<= 32 characters

Match pattern:

^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

JobStatus

enum<string>

optional

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.

Allowed values:

SUBMITTEDIN_PROGRESSCOMPLETEDCOMPLETED_WITH_ERRORFAILEDSTOP_REQUESTEDSTOPPED

🟠480TooManyRequestsException

🟠481UnsupportedLanguagePairException

🟠482InvalidRequestException

🟠483ResourceNotFoundException

🟠484InternalServerException

Modified at 2022-09-12 09:51:45