/ - Amazon Translate

Gets a list of the batch translation jobs that you have submitted.

curl --location -g --request POST 'http://translate.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "Filter": { "JobName": "string", "JobStatus": "SUBMITTED", "SubmittedBeforeTime": "string", "SubmittedAfterTime": "string" }, "NextToken": "string", "MaxResults": 0 }'

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

Filter

object

optional

The parameters that specify which batch translation jobs to retrieve. Filters include job name, job status, and submission time. You can only set one filter at a time.

JobName

string

optional

Filters the list of jobs by name.

>= 1 characters<= 256 characters

Match pattern:

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

JobStatus

enum<string>

optional

Filters the list of jobs based by job status.

Allowed values:

SUBMITTEDIN_PROGRESSCOMPLETEDCOMPLETED_WITH_ERRORFAILEDSTOP_REQUESTEDSTOPPED

SubmittedBeforeTime

string <date-time>

optional

Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

SubmittedAfterTime

string <date-time>

optional

Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

NextToken

string

optional

The token to request the next page of results.

<= 8192 characters

Match pattern:

\p{ASCII}{0,8192}

MaxResults

integer

optional

The maximum number of results to return in each page. The default value is 100.

>= 1<= 500

Examples

Responses

🟢200Success

application/json

Body

TextTranslationJobPropertiesList

array[object (TextTranslationJobProperties) {14}]

optional

A list containing the properties of each job that is returned.

JobId

string

optional

The ID of the translation job.

>= 1 characters<= 32 characters

Match pattern:

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

JobName

string

optional

The user-defined name of the translation job.

>= 1 characters<= 256 characters

Match pattern:

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

JobStatus

enum<string>

optional

The status of the translation job.

Allowed values:

SUBMITTEDIN_PROGRESSCOMPLETEDCOMPLETED_WITH_ERRORFAILEDSTOP_REQUESTEDSTOPPED

JobDetails

object

optional

The number of documents successfully and unsuccessfully processed during the translation job.

SourceLanguageCode

string

optional

The language code of the language of the source text. The language must be a language supported by Amazon Translate.

>= 2 characters<= 5 characters

TargetLanguageCodes

array[string]

optional

The language code of the language of the target text. The language must be a language supported by Amazon Translate.

>= 1 items<= 1 items

TerminologyNames

array[string]

optional

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.

ParallelDataNames

array[string]

optional

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

Message

string

optional

An explanation of any errors that may have occured during the translation job.

SubmittedTime

string <date-time>

optional

The time at which the translation job was submitted.

EndTime

string <date-time>

optional

The time at which the translation job ended.

InputDataConfig

object

optional

The input configuration properties that were specified when the job was requested.

OutputDataConfig

object

optional

The output configuration properties that were specified when the job was requested.

DataAccessRoleArn

string

optional

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.

>= 20 characters<= 2048 characters

Match pattern:

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

NextToken

string

optional

The token to use to retreive the next page of results. This value is null when there are no more results to return.

<= 8192 characters

Match pattern:

\p{ASCII}{0,8192}

🟠480InvalidRequestException

🟠481TooManyRequestsException

🟠482InvalidFilterException

🟠483InternalServerException