| Column Name | Column Data Type |
|---|
filter Input Column
The parameters that specify which batch translation jobs to retrieve. Filters include job name, job status, and submission time. You can only set one filter at a time. | STRUCT(
"job_name" VARCHAR,
"job_status" VARCHAR,
"submitted_before_time" TIMESTAMP_S,
"submitted_after_time" TIMESTAMP_S
) |
Show child fields- filter.job_name
Filters the list of jobs by name. - filter.job_status
Filters the list of jobs based by job status. - filter.submitted_after_time
Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest. - filter.submitted_before_time
Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
|
max_results Input Column
The maximum number of results to return in each page. The default value is 100. | BIGINT |
next_token Input Column
The token to use to retrieve the next page of results. This value is null when there are no more results to return. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
text_translation_job_properties_list
A list containing the properties of each job that is returned. | STRUCT(
"job_id" VARCHAR,
"job_name" VARCHAR,
"job_status" VARCHAR,
"job_details" STRUCT(
"translated_documents_count" BIGINT,
"documents_with_errors_count" BIGINT,
"input_documents_count" BIGINT
),
"source_language_code" VARCHAR,
"target_language_codes" VARCHAR[],
"terminology_names" VARCHAR[],
"parallel_data_names" VARCHAR[],
"message" VARCHAR,
"submitted_time" TIMESTAMP_S,
"end_time" TIMESTAMP_S,
"input_data_config" STRUCT(
"s3_uri" VARCHAR,
"content_type" VARCHAR
),
"output_data_config" STRUCT(
"s3_uri" VARCHAR,
"encryption_key" STRUCT(
"type" VARCHAR,
"id" VARCHAR
)
),
"data_access_role_arn" VARCHAR,
"settings" STRUCT(
"formality" VARCHAR,
"profanity" VARCHAR,
"brevity" VARCHAR
)
)[] |
Show child fields- text_translation_job_properties_list[]
Show child fields- text_translation_job_properties_list[].data_access_role_arn
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. - text_translation_job_properties_list[].end_time
The time at which the translation job ended. - text_translation_job_properties_list[].input_data_config
The input configuration properties that were specified when the job was requested. Show child fields- text_translation_job_properties_list[].input_data_config.content_type
Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types: -
text/html: The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file. -
text/plain: The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input. -
application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data consists of one or more Word documents (.docx). -
application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data consists of one or more PowerPoint Presentation files (.pptx). -
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of one or more Excel Workbook files (.xlsx). -
application/x-xliff+xml: The input data consists of one or more XML Localization Interchange File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2. If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every character. - text_translation_job_properties_list[].input_data_config.s3_uri
The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are calling.
- text_translation_job_properties_list[].job_details
The number of documents successfully and unsuccessfully processed during the translation job. Show child fields- text_translation_job_properties_list[].job_details.documents_with_errors_count
The number of documents that could not be processed during a translation job. - text_translation_job_properties_list[].job_details.input_documents_count
The number of documents used as input in a translation job. - text_translation_job_properties_list[].job_details.translated_documents_count
The number of documents successfully processed during a translation job.
- text_translation_job_properties_list[].job_id
The ID of the translation job. - text_translation_job_properties_list[].job_name
The user-defined name of the translation job. - text_translation_job_properties_list[].job_status
The status of the translation job. - text_translation_job_properties_list[].message
An explanation of any errors that may have occurred during the translation job. - text_translation_job_properties_list[].output_data_config
The output configuration properties that were specified when the job was requested. Show child fields- text_translation_job_properties_list[].output_data_config.encryption_key
The encryption key used to encrypt this object. Show child fields- text_translation_job_properties_list[].output_data_config.encryption_key.id
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object. - text_translation_job_properties_list[].output_data_config.encryption_key.type
The type of encryption key used by Amazon Translate to encrypt this object.
- text_translation_job_properties_list[].output_data_config.s3_uri
The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.
- text_translation_job_properties_list[].parallel_data_names[]
- text_translation_job_properties_list[].settings
Settings that modify the translation output. Show child fields- text_translation_job_properties_list[].settings.brevity
When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off. If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off. For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide. - text_translation_job_properties_list[].settings.formality
You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting. If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language. For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide. - text_translation_job_properties_list[].settings.profanity
You can enable the profanity setting if you want to mask profane words and phrases in your translation output. To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words. Amazon Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide. If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.
- text_translation_job_properties_list[].source_language_code
The language code of the language of the source text. The language must be a language supported by Amazon Translate. - text_translation_job_properties_list[].submitted_time
The time at which the translation job was submitted. - text_translation_job_properties_list[].target_language_codes[]
- text_translation_job_properties_list[].terminology_names[]
|