Describe Text Translation Job

translate_describe_text_translation_job

R Documentation

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

Description

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.

Usage

translate_describe_text_translation_job(JobId)

Arguments

JobId

[required] The identifier that Amazon Translate generated for the job. The start_text_translation_job operation returns this identifier in its response.

Value

A list with the following syntax:

list(
  TextTranslationJobProperties = list(
    JobId = "string",
    JobName = "string",
    JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"COMPLETED_WITH_ERROR"|"FAILED"|"STOP_REQUESTED"|"STOPPED",
    JobDetails = list(
      TranslatedDocumentsCount = 123,
      DocumentsWithErrorsCount = 123,
      InputDocumentsCount = 123
    ),
    SourceLanguageCode = "string",
    TargetLanguageCodes = list(
      "string"
    ),
    TerminologyNames = list(
      "string"
    ),
    ParallelDataNames = list(
      "string"
    ),
    Message = "string",
    SubmittedTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    ),
    InputDataConfig = list(
      S3Uri = "string",
      ContentType = "string"
    ),
    OutputDataConfig = list(
      S3Uri = "string",
      EncryptionKey = list(
        Type = "KMS",
        Id = "string"
      )
    ),
    DataAccessRoleArn = "string",
    Settings = list(
      Formality = "FORMAL"|"INFORMAL",
      Profanity = "MASK",
      Brevity = "ON"
    )
  )
)

Request syntax

svc$describe_text_translation_job(
  JobId = "string"
)