Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeTextTranslationJob

Gets the properties associated with an asynchronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.

Request Syntax


{
   "JobId": "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.

JobId

The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

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

Required: Yes

Response Syntax


{
   "TextTranslationJobProperties": { 
      "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.

TextTranslationJobProperties

An object that contains the properties associated with an asynchronous batch translation job.

Type: TextTranslationJobProperties object

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

ResourceNotFoundException

The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised 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