text_translation_jobs

Creates, updates, deletes, gets or lists a text_translation_jobs resource.

Overview

Name	text_translation_jobs
Type	Resource
Id	aws.translate.text_translation_jobs

Fields

The following fields are returned by SELECT queries:

describe_text_translation_job

Name	Datatype	Description
data_access_role_arn	string	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. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
end_time	string (date-time)	The time at which the translation job ended.
input_data_config	object	The input configuration properties that were specified when the job was requested.
job_details	object	The number of documents successfully and unsuccessfully processed during the translation job.
job_id	string	The ID of the translation job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_name	string	The user-defined name of the translation job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_status	string	The status of the translation job. (SUBMITTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERROR, FAILED, STOP_REQUESTED, STOPPED)
message	string	An explanation of any errors that may have occurred during the translation job.
output_data_config	object	The output configuration properties that were specified when the job was requested.
parallel_data_names	array	A list containing the names of the parallel data resources applied to the translation job.
settings	object	Settings that modify the translation output.
source_language_code	string	The language code of the language of the source text. The language must be a language supported by Amazon Translate.
submitted_time	string (date-time)	The time at which the translation job was submitted.
target_language_codes	array	The language code of the language of the target text. The language must be a language supported by Amazon Translate.
terminology_names	array	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.

list_text_translation_jobs

Name	Datatype	Description
next_token	string	The token to use to retrieve the next page of results. This value is null when there are no more results to return. (pattern: <code>\p{ASCII}{0,8192}</code>)
text_translation_job_properties_list	array	A list containing the properties of each job that is returned.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_text_translation_job	select	region		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.
list_text_translation_jobs	select	region		Gets a list of the batch translation jobs that you have submitted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_text_translation_job

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.

SELECT
data_access_role_arn,
end_time,
input_data_config,
job_details,
job_id,
job_name,
job_status,
message,
output_data_config,
parallel_data_names,
settings,
source_language_code,
submitted_time,
target_language_codes,
terminology_names
FROM aws.translate.text_translation_jobs
WHERE region = '{{ region }}' -- required
;

list_text_translation_jobs

Gets a list of the batch translation jobs that you have submitted.

SELECT
next_token,
text_translation_job_properties_list
FROM aws.translate.text_translation_jobs
WHERE region = '{{ region }}' -- required
;