Amazon Translate
    Amazon Translate
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST

      /

      The Amazon Translate multi-region endpoint
      http://translate.{region}.amazonaws.com
      The Amazon Translate multi-region endpoint
      http://translate.{region}.amazonaws.com
      POST
      /
      Gets the properties associated with an asycnhronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.
      Request 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 '{
    "JobId": "string"
}'
      Response Response Example
      200 - Example 1
      {
    "TextTranslationJobProperties": {
        "JobId": "string",
        "JobName": "string",
        "JobStatus": "SUBMITTED",
        "JobDetails": {
            "TranslatedDocumentsCount": 0,
            "DocumentsWithErrorsCount": 0,
            "InputDocumentsCount": 0
        },
        "SourceLanguageCode": "string",
        "TargetLanguageCodes": [],
        "TerminologyNames": [],
        "ParallelDataNames": [],
        "Message": "string",
        "SubmittedTime": "string",
        "EndTime": "string",
        "InputDataConfig": {
            "S3Uri": "string",
            "ContentType": "string"
        },
        "OutputDataConfig": {
            "S3Uri": "string"
        },
        "DataAccessRoleArn": "string"
    }
}

      Request

      Header Params
      X-Amz-Target
      string 
      required
      Body Params application/json
      JobId
      string 
      required
      The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.
      >= 1 characters<= 32 characters
      Match pattern:
      ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
      Examples

      Responses

      🟢200Success
      application/json
      Body
      TextTranslationJobProperties
      object 
      optional
      An object that contains the properties associated with an asynchronous batch translation job.
      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/.+
      🟠480ResourceNotFoundException
      🟠481TooManyRequestsException
      🟠482InternalServerException
      Previous
      /
      Next
      /
      Built with