TextTranslationJobProperties - Amazon Translate API Reference

TextTranslationJobProperties

Provides information about a translation job.

Contents

DataAccessRoleArn

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. For more information, see Prerequisite permissions in the Amazon Translate Developer Guide.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

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

Required: No

EndTime

The time at which the translation job ended.

Type: Timestamp

Required: No

InputDataConfig

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

Type: InputDataConfig object

Required: No

JobDetails

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

Type: JobDetails object

Required: No

JobId

The ID of the translation job.

Type: String

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

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

Required: No

JobName

The user-defined name of the translation job.

Type: String

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

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

Required: No

JobStatus

The status of the translation job.

Type: String

Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERROR | FAILED | STOP_REQUESTED | STOPPED

Required: No

Message

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

Type: String

Required: No

OutputDataConfig

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

Type: OutputDataConfig object

Required: No

ParallelDataNames

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

Type: Array of strings

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

Pattern: ^([A-Za-z0-9-]_?)+$

Required: No

Settings

Settings that modify the translation output.

Type: TranslationSettings object

Required: No

SourceLanguageCode

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

Type: String

Length Constraints: Minimum length of 2. Maximum length of 5.

Required: No

SubmittedTime

The time at which the translation job was submitted.

Type: Timestamp

Required: No

TargetLanguageCodes

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

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 2. Maximum length of 5.

Required: No

TerminologyNames

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.

Type: Array of strings

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

Pattern: ^([A-Za-z0-9-]_?)+$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: