Skip to content

TextTranslationJobProperties

Source code in docs_src/capo_translate/types/text_translation_job_properties.py
class TextTranslationJobProperties(TypedDict, closed=True):
    job_id: NotRequired["capo_translate.types.job_id.JobId"]
    """<p>The ID of the translation job.</p>"""
    job_name: NotRequired["capo_translate.types.job_name.JobName"]
    """<p>The user-defined name of the translation job.</p>"""
    job_status: NotRequired["capo_translate.types.job_status.JobStatus"]
    """<p>The status of the translation job.</p>"""
    job_details: NotRequired["capo_translate.types.job_details.JobDetails"]
    """<p>The number of documents successfully and unsuccessfully processed during the translation job.</p>"""
    source_language_code: NotRequired[
        "capo_translate.types.language_code_string.LanguageCodeString"
    ]
    """<p>The language code of the language of the source text. The language must be a language supported by Amazon Translate.</p>"""
    target_language_codes: NotRequired[
        "capo_translate.types.target_language_code_string_list.TargetLanguageCodeStringList"
    ]
    """<p>The language code of the language of the target text. The language must be a language supported by Amazon Translate.</p>"""
    terminology_names: NotRequired[
        "capo_translate.types.resource_name_list.ResourceNameList"
    ]
    """<p>A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per <a>StartTextTranslationJob</a> request at this time.</p>"""
    parallel_data_names: NotRequired[
        "capo_translate.types.resource_name_list.ResourceNameList"
    ]
    """<p>A list containing the names of the parallel data resources applied to the translation job.</p>"""
    message: NotRequired[
        "capo_translate.types.unbounded_length_string.UnboundedLengthString"
    ]
    """<p>An explanation of any errors that may have occurred during the translation job.</p>"""
    submitted_time: NotRequired["capo_translate.types.timestamp.Timestamp"]
    """<p>The time at which the translation job was submitted.</p>"""
    end_time: NotRequired["capo_translate.types.timestamp.Timestamp"]
    """<p>The time at which the translation job ended.</p>"""
    input_data_config: NotRequired[
        "capo_translate.types.input_data_config.InputDataConfig"
    ]
    """<p>The input configuration properties that were specified when the job was requested.</p>"""
    output_data_config: NotRequired[
        "capo_translate.types.output_data_config.OutputDataConfig"
    ]
    """<p>The output configuration properties that were specified when the job was requested.</p>"""
    data_access_role_arn: NotRequired["capo_translate.types.iam_role_arn.IamRoleArn"]
    """<p>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.</p>"""
    settings: NotRequired[
        "capo_translate.types.translation_settings.TranslationSettings"
    ]
    """<p>Settings that modify the translation output.</p>"""

data_access_role_arn instance-attribute

data_access_role_arn: NotRequired[IamRoleArn]

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.

end_time instance-attribute

end_time: NotRequired[Timestamp]

The time at which the translation job ended.

input_data_config instance-attribute

input_data_config: NotRequired[InputDataConfig]

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

job_details instance-attribute

job_details: NotRequired[JobDetails]

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

job_id instance-attribute

job_id: NotRequired[JobId]

The ID of the translation job.

job_name instance-attribute

job_name: NotRequired[JobName]

The user-defined name of the translation job.

job_status instance-attribute

job_status: NotRequired[JobStatus]

The status of the translation job.

message instance-attribute

message: NotRequired[UnboundedLengthString]

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

output_data_config instance-attribute

output_data_config: NotRequired[OutputDataConfig]

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

parallel_data_names instance-attribute

parallel_data_names: NotRequired[ResourceNameList]

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

settings instance-attribute

settings: NotRequired[TranslationSettings]

Settings that modify the translation output.

source_language_code instance-attribute

source_language_code: NotRequired[LanguageCodeString]

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

submitted_time instance-attribute

submitted_time: NotRequired[Timestamp]

The time at which the translation job was submitted.

target_language_codes instance-attribute

target_language_codes: NotRequired[TargetLanguageCodeStringList]

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

terminology_names instance-attribute

terminology_names: NotRequired[ResourceNameList]

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.