String name
The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.
List<E> terms
The specific terms of the custom terminology applied to the input text by Amazon Translate for the translated text response. A maximum of 250 terms will be returned, and the specific terms applied will be the first 250 terms in the source text.
String name
A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.
String description
A custom description for the parallel data resource in Amazon Translate.
ParallelDataConfig parallelDataConfig
Specifies the format and S3 location of the parallel data input file.
EncryptionKey encryptionKey
String clientToken
A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.
String name
The name of the parallel data resource that is being deleted.
String name
The name of the custom terminology being deleted.
String jobId
The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.
TextTranslationJobProperties textTranslationJobProperties
An object that contains the properties associated with an asynchronous batch translation job.
String detectedLanguageCode
The language code of the auto-detected language from Amazon Comprehend.
String name
The name of the parallel data resource that is being retrieved.
ParallelDataProperties parallelDataProperties
The properties of the parallel data resource that is being retrieved.
ParallelDataDataLocation dataLocation
The Amazon S3 location of the most recent parallel data input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.
Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.
CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.
Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.
ParallelDataDataLocation auxiliaryDataLocation
The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a parallel data resource. The location is returned as a presigned URL to that has a 30-minute expiration.
ParallelDataDataLocation latestUpdateAttemptAuxiliaryDataLocation
The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to update a parallel data resource. The location is returned as a presigned URL to that has a 30-minute expiration.
String name
The name of the custom terminology being retrieved.
String terminologyDataFormat
The data format of the custom terminology being retrieved.
If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was imported to create the terminology.
If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.
TerminologyProperties terminologyProperties
The properties of the custom terminology being retrieved.
TerminologyDataLocation terminologyDataLocation
The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.
Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.
CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.
Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.
TerminologyDataLocation auxiliaryDataLocation
The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30-minute expiration.
String name
The name of the custom terminology being imported.
String mergeStrategy
The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE merge strategy is supported. In this case, the imported terminology will overwrite an existing terminology of the same name.
String description
The description of the custom terminology being imported.
TerminologyData terminologyData
The terminology data for the custom terminology being imported.
EncryptionKey encryptionKey
The encryption key for the custom terminology being imported.
TerminologyProperties terminologyProperties
The properties of the custom terminology being imported.
TerminologyDataLocation auxiliaryDataLocation
The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30 minute expiration.
String s3Uri
The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the folder. The folder must be in the same Region as the API endpoint you are calling.
The URI can also point to a single input document, or it can provide the prefix for a collection of input
documents. For example. if you use the URI S3://bucketName/prefix and the prefix is a single file,
Amazon Translate uses that files as input. If more than one file begins with the prefix, Amazon Translate uses
all of them as input.
String contentType
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.
Integer translatedDocumentsCount
The number of documents successfully processed during a translation job.
Integer documentsWithErrorsCount
The number of documents that could not be processed during a translation job.
Integer inputDocumentsCount
The number of documents used as input in a translation job.
String displayLanguageCode
The language code for the language to use to display the language names in the response. The language code is
en by default.
String nextToken
Include the NextToken value to fetch the next group of supported languages.
Integer maxResults
The maximum number of results to return in each response.
List<E> languages
The list of supported languages.
String displayLanguageCode
The language code passed in with the request.
String nextToken
If the response does not include all remaining results, use the NextToken in the next request to fetch the next group of supported languages.
List<E> parallelDataPropertiesList
The properties of the parallel data resources returned by this request.
String nextToken
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
TextTranslationJobFilter filter
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.
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of results to return in each page. The default value is 100.
String s3Uri
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.
EncryptionKey encryptionKey
String repositoryType
Describes the repository that contains the parallel data input file.
String location
The Amazon S3 location of the parallel data input file. The location is returned as a presigned URL to that has a 30-minute expiration.
Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.
CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.
Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.
String name
The custom name assigned to the parallel data resource.
String arn
The Amazon Resource Name (ARN) of the parallel data resource.
String description
The description assigned to the parallel data resource.
String status
The status of the parallel data resource. When the parallel data is ready for you to use, the status is
ACTIVE.
String sourceLanguageCode
The source language of the translations in the parallel data file.
List<E> targetLanguageCodes
The language codes for the target languages available in the parallel data file. All possible target languages are returned as an array.
ParallelDataConfig parallelDataConfig
Specifies the format and S3 location of the parallel data input file.
String message
Additional information from Amazon Translate about the parallel data resource.
Long importedDataSize
The number of UTF-8 characters that Amazon Translate imported from the parallel data input file. This number includes only the characters in your translation examples. It does not include characters that are used to format your file. For example, if you provided a Translation Memory Exchange (.tmx) file, this number does not include the tags.
Long importedRecordCount
The number of records successfully imported from the parallel data input file.
Long failedRecordCount
The number of records unsuccessfully imported from the parallel data input file.
Long skippedRecordCount
The number of items in the input file that Amazon Translate skipped when you created or updated the parallel data resource. For example, Amazon Translate skips empty records, empty target texts, and empty lines.
EncryptionKey encryptionKey
Date createdAt
The time at which the parallel data resource was created.
Date lastUpdatedAt
The time at which the parallel data resource was last updated.
String latestUpdateAttemptStatus
The status of the most recent update attempt for the parallel data resource.
Date latestUpdateAttemptAt
The time that the most recent update was attempted.
String jobName
The name of the batch translation job to be performed.
InputDataConfig inputDataConfig
Specifies the format and location of the input documents for the translation job.
OutputDataConfig outputDataConfig
Specifies the S3 folder to which your job output will be saved.
String dataAccessRoleArn
The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see identity-and-access-management.
String sourceLanguageCode
The language code of the input language. For a list of language codes, see what-is-languages.
Amazon Translate does not automatically detect a source language during batch translation jobs.
List<E> targetLanguageCodes
The language code of the output language.
List<E> terminologyNames
The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.
This parameter accepts only one custom terminology resource.
For a list of available custom terminology resources, use the ListTerminologies operation.
For more information, see how-custom-terminology.
List<E> parallelDataNames
The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.
This parameter accepts only one parallel data resource.
Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.
For a list of available parallel data resources, use the ListParallelData operation.
For more information, see customizing-translations-parallel-data.
String clientToken
A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.
TranslationSettings settings
Settings to configure your translation output, including the option to mask profane words and phrases.
StartTextTranslationJob does not support the formality setting.
String jobId
The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.
String jobStatus
The status of the job. Possible values include:
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Translate is processing the job.
COMPLETED - The job was successfully completed and the output is available.
COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's
output.
FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob
operation.
STOP_REQUESTED - The user who started the job has requested that it be stopped.
STOPPED - The job has been stopped.
String jobId
The job ID of the job to be stopped.
ByteBuffer file
The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.
String format
The data format of the custom terminology.
String directionality
The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
The terminology resource has one source language (for example, the first column in a CSV file), and all of its other languages are target languages.
Any language in the terminology resource can be the source language or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.
When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.
String repositoryType
The repository type for the custom terminology data.
String location
The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration .
Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.
CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.
Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.
String name
The name of the custom terminology.
String description
The description of the custom terminology properties.
String arn
The Amazon Resource Name (ARN) of the custom terminology.
String sourceLanguageCode
The language code for the source text of the translation request for which the custom terminology is being used.
List<E> targetLanguageCodes
The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.
EncryptionKey encryptionKey
The encryption key for the custom terminology.
Integer sizeBytes
The size of the file used when importing a custom terminology.
Integer termCount
The number of terms included in the custom terminology.
Date createdAt
The time at which the custom terminology was created, based on the timestamp.
Date lastUpdatedAt
The time at which the custom terminology was last update, based on the timestamp.
String directionality
The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.
Any language in the terminology resource can be the source language.
String message
Additional information from Amazon Translate about the terminology resource.
Integer skippedTermCount
The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.
String format
The format of the custom terminology input file.
String jobName
Filters the list of jobs by name.
String jobStatus
Filters the list of jobs based by job status.
Date submittedBeforeTime
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.
Date submittedAfterTime
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.
String jobId
The ID of the translation job.
String jobName
The user-defined name of the translation job.
String jobStatus
The status of the translation job.
JobDetails jobDetails
The number of documents successfully and unsuccessfully processed during the translation job.
String sourceLanguageCode
The language code of the language of the source text. The language must be a language supported by Amazon Translate.
List<E> targetLanguageCodes
The language code of the language of the target text. The language must be a language supported by Amazon Translate.
List<E> 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.
List<E> parallelDataNames
A list containing the names of the parallel data resources applied to the translation job.
String message
An explanation of any errors that may have occurred during the translation job.
Date submittedTime
The time at which the translation job was submitted.
Date endTime
The time at which the translation job ended.
InputDataConfig inputDataConfig
The input configuration properties that were specified when the job was requested.
OutputDataConfig outputDataConfig
The output configuration properties that were specified when the job was requested.
String 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.
TranslationSettings settings
Settings that configure the translation output.
String text
The text to translate. The text string can be a maximum of 5,000 bytes long. Depending on your character set, this may be fewer than 5,000 characters.
List<E> terminologyNames
The name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at
most in a TranslateText request. Terminology lists can contain a maximum of 256 terms.
String sourceLanguageCode
The language code for the language of the source text. The language must be a language supported by Amazon Translate. For a list of language codes, see what-is-languages.
To have Amazon Translate determine the source language of your text, you can specify auto in the
SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to
determine the source language.
If you specify auto, you must send the TranslateText request in a region that supports
Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.
String targetLanguageCode
The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.
TranslationSettings settings
Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.
String translatedText
The translated text.
String sourceLanguageCode
The language code for the language of the source text.
String targetLanguageCode
The language code for the language of the target text.
List<E> appliedTerminologies
The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.
TranslationSettings appliedSettings
Settings that configure the translation output.
String formality
You can optionally specify the desired level of formality for real-time 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.
Note that asynchronous translation jobs don't support formality. If you provide a value for formality, the
StartTextTranslationJob API throws an exception (InvalidRequestException).
For target languages that support formality, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.
String profanity
Enable the profanity setting if you want Amazon Translate 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 support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.
String displayLanguageCode
Language code passed in with the request.
String name
The name of the parallel data resource being updated.
String description
A custom description for the parallel data resource in Amazon Translate.
ParallelDataConfig parallelDataConfig
Specifies the format and S3 location of the parallel data input file.
String clientToken
A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.
String name
The name of the parallel data resource being updated.
String status
The status of the parallel data resource that you are attempting to update. Your update request is accepted only
if this status is either ACTIVE or FAILED.
String latestUpdateAttemptStatus
The status of the parallel data update attempt. When the updated parallel data resource is ready for you to use,
the status is ACTIVE.
Date latestUpdateAttemptAt
The time that the most recent update was attempted.
Copyright © 2022. All rights reserved.