Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListTextTranslationJobs

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

Request Syntax


{
   "Filter": { 
      "JobName": "string",
      "JobStatus": "string",
      "SubmittedAfterTime": number,
      "SubmittedBeforeTime": number
   },
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filter

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.

Type: TextTranslationJobFilter object

Required: No

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

NextToken

The token to request the next page of results.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

Required: No

Response Syntax


{
   "NextToken": "string",
   "TextTranslationJobPropertiesList": [ 
      { 
         "DataAccessRoleArn": "string",
         "EndTime": number,
         "InputDataConfig": { 
            "ContentType": "string",
            "S3Uri": "string"
         },
         "JobDetails": { 
            "DocumentsWithErrorsCount": number,
            "InputDocumentsCount": number,
            "TranslatedDocumentsCount": number
         },
         "JobId": "string",
         "JobName": "string",
         "JobStatus": "string",
         "Message": "string",
         "OutputDataConfig": { 
            "EncryptionKey": { 
               "Id": "string",
               "Type": "string"
            },
            "S3Uri": "string"
         },
         "ParallelDataNames": [ "string" ],
         "Settings": { 
            "Brevity": "string",
            "Formality": "string",
            "Profanity": "string"
         },
         "SourceLanguageCode": "string",
         "SubmittedTime": number,
         "TargetLanguageCodes": [ "string" ],
         "TerminologyNames": [ "string" ]
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

Length Constraints: Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

TextTranslationJobPropertiesList

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

Type: Array of TextTranslationJobProperties objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

InvalidFilterException

The filter specified for the operation is not valid. Specify a different filter.

HTTP Status Code: 400

InvalidRequestException

The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.

HTTP Status Code: 400

TooManyRequestsException

You have made too many requests within a short period of time. Wait for a short time and then try your request again.

HTTP Status Code: 400