Table of Contents
Translate.Client¶A low-level client representing Amazon Translate
Provides translation of the input content from the source language to the target language.
import boto3
client = boto3.client('translate')
These are the available methods:
can_paginate()close()create_parallel_data()delete_parallel_data()delete_terminology()describe_text_translation_job()get_paginator()get_parallel_data()get_terminology()get_waiter()import_terminology()list_languages()list_parallel_data()list_tags_for_resource()list_terminologies()list_text_translation_jobs()start_text_translation_job()stop_text_translation_job()tag_resource()translate_text()untag_resource()update_parallel_data()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_parallel_data(**kwargs)¶Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3. Parallel data files contain examples that show how you want segments of text to be translated. By adding parallel data, you can influence the style, tone, and word choice in your translation output.
See also: AWS API Documentation
Request Syntax
response = client.create_parallel_data(
Name='string',
Description='string',
ParallelDataConfig={
'S3Uri': 'string',
'Format': 'TSV'|'CSV'|'TMX'
},
EncryptionKey={
'Type': 'KMS',
'Id': 'string'
},
ClientToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.
[REQUIRED]
Specifies the format and S3 location of the parallel data input file.
The URI of the Amazon S3 folder that contains the parallel data input file. The folder must be in the same Region as the API endpoint you are calling.
The format of the parallel data input file.
The encryption key used to encrypt this object.
The type of encryption key used by Amazon Translate to encrypt this object.
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
[REQUIRED]
A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.
This field is autopopulated if not provided.
Tags to be associated with this resource. A tag is a key-value pair that adds metadata to a resource. Each tag key for the resource must be unique. For more information, see Tagging your resources.
A key-value pair that adds as a metadata to a resource used by Amazon Translate.
The initial part of a key-value pair that forms a tag associated with a given resource.
The second part of a key-value pair that forms a tag associated with a given resource.
dict
Response Syntax
{
'Name': 'string',
'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED'
}
Response Structure
(dict) --
Name (string) --
The custom name that you assigned to the parallel data resource.
Status (string) --
The status of the parallel data resource. When the resource is ready for you to use, the status is ACTIVE .
Exceptions
Translate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.InvalidRequestExceptionTranslate.Client.exceptions.LimitExceededExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.TooManyTagsExceptionTranslate.Client.exceptions.ConflictExceptionTranslate.Client.exceptions.ConcurrentModificationExceptionTranslate.Client.exceptions.InternalServerExceptiondelete_parallel_data(**kwargs)¶Deletes a parallel data resource in Amazon Translate.
See also: AWS API Documentation
Request Syntax
response = client.delete_parallel_data(
Name='string'
)
[REQUIRED]
The name of the parallel data resource that is being deleted.
{
'Name': 'string',
'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED'
}
Response Structure
The name of the parallel data resource that is being deleted.
The status of the parallel data deletion.
Exceptions
Translate.Client.exceptions.ConcurrentModificationExceptionTranslate.Client.exceptions.ResourceNotFoundExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.InternalServerExceptiondelete_terminology(**kwargs)¶A synchronous action that deletes a custom terminology.
See also: AWS API Documentation
Request Syntax
response = client.delete_terminology(
Name='string'
)
[REQUIRED]
The name of the custom terminology being deleted.
Exceptions
Translate.Client.exceptions.ResourceNotFoundExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.InternalServerExceptiondescribe_text_translation_job(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_text_translation_job(
JobId='string'
)
[REQUIRED]
The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.
{
'TextTranslationJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'JobDetails': {
'TranslatedDocumentsCount': 123,
'DocumentsWithErrorsCount': 123,
'InputDocumentsCount': 123
},
'SourceLanguageCode': 'string',
'TargetLanguageCodes': [
'string',
],
'TerminologyNames': [
'string',
],
'ParallelDataNames': [
'string',
],
'Message': 'string',
'SubmittedTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'ContentType': 'string'
},
'OutputDataConfig': {
'S3Uri': 'string',
'EncryptionKey': {
'Type': 'KMS',
'Id': 'string'
}
},
'DataAccessRoleArn': 'string',
'Settings': {
'Formality': 'FORMAL'|'INFORMAL',
'Profanity': 'MASK'
}
}
}
Response Structure
An object that contains the properties associated with an asynchronous batch translation job.
The ID of the translation job.
The user-defined name of the translation job.
The status of the translation job.
The number of documents successfully and unsuccessfully processed during the translation job.
The number of documents successfully processed during a translation job.
The number of documents that could not be processed during a translation job.
The number of documents used as input in a translation job.
The language code of the language of the source text. The language must be a language supported by Amazon Translate.
The language code of the language of the target text. The language must be a language supported by Amazon Translate.
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.
A list containing the names of the parallel data resources applied to the translation job.
An explanation of any errors that may have occurred during the translation job.
The time at which the translation job was submitted.
The time at which the translation job ended.
The input configuration properties that were specified when the job was requested.
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.
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.Warning
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.
The output configuration properties that were specified when the job was requested.
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.
The encryption key used to encrypt this object.
The type of encryption key used by Amazon Translate to encrypt this object.
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
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.
Settings that configure the translation output.
You can optionally 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.
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 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.
Exceptions
Translate.Client.exceptions.ResourceNotFoundExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.InternalServerExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_parallel_data(**kwargs)¶Provides information about a parallel data resource.
See also: AWS API Documentation
Request Syntax
response = client.get_parallel_data(
Name='string'
)
[REQUIRED]
The name of the parallel data resource that is being retrieved.
{
'ParallelDataProperties': {
'Name': 'string',
'Arn': 'string',
'Description': 'string',
'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
'SourceLanguageCode': 'string',
'TargetLanguageCodes': [
'string',
],
'ParallelDataConfig': {
'S3Uri': 'string',
'Format': 'TSV'|'CSV'|'TMX'
},
'Message': 'string',
'ImportedDataSize': 123,
'ImportedRecordCount': 123,
'FailedRecordCount': 123,
'SkippedRecordCount': 123,
'EncryptionKey': {
'Type': 'KMS',
'Id': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'LatestUpdateAttemptStatus': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
'LatestUpdateAttemptAt': datetime(2015, 1, 1)
},
'DataLocation': {
'RepositoryType': 'string',
'Location': 'string'
},
'AuxiliaryDataLocation': {
'RepositoryType': 'string',
'Location': 'string'
},
'LatestUpdateAttemptAuxiliaryDataLocation': {
'RepositoryType': 'string',
'Location': 'string'
}
}
Response Structure
The properties of the parallel data resource that is being retrieved.
The custom name assigned to the parallel data resource.
The Amazon Resource Name (ARN) of the parallel data resource.
The description assigned to the parallel data resource.
The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE .
The source language of the translations in the parallel data file.
The language codes for the target languages available in the parallel data file. All possible target languages are returned as an array.
Specifies the format and S3 location of the parallel data input file.
The URI of the Amazon S3 folder that contains the parallel data input file. The folder must be in the same Region as the API endpoint you are calling.
The format of the parallel data input file.
Additional information from Amazon Translate about the parallel data resource.
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.
The number of records successfully imported from the parallel data input file.
The number of records unsuccessfully imported from the parallel data input file.
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.
The encryption key used to encrypt this object.
The type of encryption key used by Amazon Translate to encrypt this object.
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
The time at which the parallel data resource was created.
The time at which the parallel data resource was last updated.
The status of the most recent update attempt for the parallel data resource.
The time that the most recent update was attempted.
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.
Warning
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.
Describes the repository that contains the parallel data input file.
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.
Warning
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.
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.
Describes the repository that contains the parallel data input file.
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.
Warning
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.
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.
Describes the repository that contains the parallel data input file.
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.
Warning
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.
Exceptions
Translate.Client.exceptions.ResourceNotFoundExceptionTranslate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.InternalServerExceptionget_terminology(**kwargs)¶Retrieves a custom terminology.
See also: AWS API Documentation
Request Syntax
response = client.get_terminology(
Name='string',
TerminologyDataFormat='CSV'|'TMX'|'TSV'
)
[REQUIRED]
The name of the custom terminology being retrieved.
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.
dict
Response Syntax
{
'TerminologyProperties': {
'Name': 'string',
'Description': 'string',
'Arn': 'string',
'SourceLanguageCode': 'string',
'TargetLanguageCodes': [
'string',
],
'EncryptionKey': {
'Type': 'KMS',
'Id': 'string'
},
'SizeBytes': 123,
'TermCount': 123,
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Directionality': 'UNI'|'MULTI',
'Message': 'string',
'SkippedTermCount': 123,
'Format': 'CSV'|'TMX'|'TSV'
},
'TerminologyDataLocation': {
'RepositoryType': 'string',
'Location': 'string'
},
'AuxiliaryDataLocation': {
'RepositoryType': 'string',
'Location': 'string'
}
}
Response Structure
(dict) --
TerminologyProperties (dict) --
The properties of the custom terminology being retrieved.
Name (string) --
The name of the custom terminology.
Description (string) --
The description of the custom terminology properties.
Arn (string) --
The Amazon Resource Name (ARN) of the custom terminology.
SourceLanguageCode (string) --
The language code for the source text of the translation request for which the custom terminology is being used.
TargetLanguageCodes (list) --
The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.
EncryptionKey (dict) --
The encryption key for the custom terminology.
Type (string) --
The type of encryption key used by Amazon Translate to encrypt this object.
Id (string) --
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
SizeBytes (integer) --
The size of the file used when importing a custom terminology.
TermCount (integer) --
The number of terms included in the custom terminology.
CreatedAt (datetime) --
The time at which the custom terminology was created, based on the timestamp.
LastUpdatedAt (datetime) --
The time at which the custom terminology was last update, based on the timestamp.
Directionality (string) --
The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
UNI
The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.
MULTI
Any language in the terminology resource can be the source language.
Message (string) --
Additional information from Amazon Translate about the terminology resource.
SkippedTermCount (integer) --
The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.
Format (string) --
The format of the custom terminology input file.
TerminologyDataLocation (dict) --
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.
Warning
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.
RepositoryType (string) --
The repository type for the custom terminology data.
Location (string) --
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 .
Warning
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.
AuxiliaryDataLocation (dict) --
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.
RepositoryType (string) --
The repository type for the custom terminology data.
Location (string) --
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 .
Warning
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.
Exceptions
Translate.Client.exceptions.ResourceNotFoundExceptionTranslate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.InternalServerExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
import_terminology(**kwargs)¶Creates or updates a custom terminology, depending on whether one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. The only supported merge strategy is OVERWRITE, where the imported terminology overwrites the existing terminology of the same name.
If you import a terminology that overwrites an existing one, the new terminology takes up to 10 minutes to fully propagate. After that, translations have access to the new terminology.
See also: AWS API Documentation
Request Syntax
response = client.import_terminology(
Name='string',
MergeStrategy='OVERWRITE',
Description='string',
TerminologyData={
'File': b'bytes',
'Format': 'CSV'|'TMX'|'TSV',
'Directionality': 'UNI'|'MULTI'
},
EncryptionKey={
'Type': 'KMS',
'Id': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the custom terminology being imported.
[REQUIRED]
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.
[REQUIRED]
The terminology data for the custom terminology being imported.
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.
The data format of the custom terminology.
The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
UNI
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.
MULTI
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.
The encryption key for the custom terminology being imported.
The type of encryption key used by Amazon Translate to encrypt this object.
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
Tags to be associated with this resource. A tag is a key-value pair that adds metadata to a resource. Each tag key for the resource must be unique. For more information, see Tagging your resources.
A key-value pair that adds as a metadata to a resource used by Amazon Translate.
The initial part of a key-value pair that forms a tag associated with a given resource.
The second part of a key-value pair that forms a tag associated with a given resource.
dict
Response Syntax
{
'TerminologyProperties': {
'Name': 'string',
'Description': 'string',
'Arn': 'string',
'SourceLanguageCode': 'string',
'TargetLanguageCodes': [
'string',
],
'EncryptionKey': {
'Type': 'KMS',
'Id': 'string'
},
'SizeBytes': 123,
'TermCount': 123,
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Directionality': 'UNI'|'MULTI',
'Message': 'string',
'SkippedTermCount': 123,
'Format': 'CSV'|'TMX'|'TSV'
},
'AuxiliaryDataLocation': {
'RepositoryType': 'string',
'Location': 'string'
}
}
Response Structure
(dict) --
TerminologyProperties (dict) --
The properties of the custom terminology being imported.
Name (string) --
The name of the custom terminology.
Description (string) --
The description of the custom terminology properties.
Arn (string) --
The Amazon Resource Name (ARN) of the custom terminology.
SourceLanguageCode (string) --
The language code for the source text of the translation request for which the custom terminology is being used.
TargetLanguageCodes (list) --
The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.
EncryptionKey (dict) --
The encryption key for the custom terminology.
Type (string) --
The type of encryption key used by Amazon Translate to encrypt this object.
Id (string) --
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
SizeBytes (integer) --
The size of the file used when importing a custom terminology.
TermCount (integer) --
The number of terms included in the custom terminology.
CreatedAt (datetime) --
The time at which the custom terminology was created, based on the timestamp.
LastUpdatedAt (datetime) --
The time at which the custom terminology was last update, based on the timestamp.
Directionality (string) --
The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
UNI
The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.
MULTI
Any language in the terminology resource can be the source language.
Message (string) --
Additional information from Amazon Translate about the terminology resource.
SkippedTermCount (integer) --
The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.
Format (string) --
The format of the custom terminology input file.
AuxiliaryDataLocation (dict) --
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.
RepositoryType (string) --
The repository type for the custom terminology data.
Location (string) --
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 .
Warning
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.
Exceptions
Translate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.LimitExceededExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.TooManyTagsExceptionTranslate.Client.exceptions.ConcurrentModificationExceptionTranslate.Client.exceptions.InternalServerExceptionlist_languages(**kwargs)¶Provides a list of languages (RFC-5646 codes and names) that Amazon Translate supports.
See also: AWS API Documentation
Request Syntax
response = client.list_languages(
DisplayLanguageCode='de'|'en'|'es'|'fr'|'it'|'ja'|'ko'|'pt'|'zh'|'zh-TW',
NextToken='string',
MaxResults=123
)
en by default.dict
Response Syntax
{
'Languages': [
{
'LanguageName': 'string',
'LanguageCode': 'string'
},
],
'DisplayLanguageCode': 'de'|'en'|'es'|'fr'|'it'|'ja'|'ko'|'pt'|'zh'|'zh-TW',
'NextToken': 'string'
}
Response Structure
(dict) --
Languages (list) --
The list of supported languages.
(dict) --
A supported language.
LanguageName (string) --
Language name of the supported language.
LanguageCode (string) --
Language code for the supported language.
DisplayLanguageCode (string) --
The language code passed in with the request.
NextToken (string) --
If the response does not include all remaining results, use the NextToken in the next request to fetch the next group of supported languages.
Exceptions
Translate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.UnsupportedDisplayLanguageCodeExceptionTranslate.Client.exceptions.InternalServerExceptionlist_parallel_data(**kwargs)¶Provides a list of your parallel data resources in Amazon Translate.
See also: AWS API Documentation
Request Syntax
response = client.list_parallel_data(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'ParallelDataPropertiesList': [
{
'Name': 'string',
'Arn': 'string',
'Description': 'string',
'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
'SourceLanguageCode': 'string',
'TargetLanguageCodes': [
'string',
],
'ParallelDataConfig': {
'S3Uri': 'string',
'Format': 'TSV'|'CSV'|'TMX'
},
'Message': 'string',
'ImportedDataSize': 123,
'ImportedRecordCount': 123,
'FailedRecordCount': 123,
'SkippedRecordCount': 123,
'EncryptionKey': {
'Type': 'KMS',
'Id': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'LatestUpdateAttemptStatus': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
'LatestUpdateAttemptAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ParallelDataPropertiesList (list) --
The properties of the parallel data resources returned by this request.
(dict) --
The properties of a parallel data resource.
Name (string) --
The custom name assigned to the parallel data resource.
Arn (string) --
The Amazon Resource Name (ARN) of the parallel data resource.
Description (string) --
The description assigned to the parallel data resource.
Status (string) --
The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE .
SourceLanguageCode (string) --
The source language of the translations in the parallel data file.
TargetLanguageCodes (list) --
The language codes for the target languages available in the parallel data file. All possible target languages are returned as an array.
ParallelDataConfig (dict) --
Specifies the format and S3 location of the parallel data input file.
S3Uri (string) --
The URI of the Amazon S3 folder that contains the parallel data input file. The folder must be in the same Region as the API endpoint you are calling.
Format (string) --
The format of the parallel data input file.
Message (string) --
Additional information from Amazon Translate about the parallel data resource.
ImportedDataSize (integer) --
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.
ImportedRecordCount (integer) --
The number of records successfully imported from the parallel data input file.
FailedRecordCount (integer) --
The number of records unsuccessfully imported from the parallel data input file.
SkippedRecordCount (integer) --
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 (dict) --
The encryption key used to encrypt this object.
Type (string) --
The type of encryption key used by Amazon Translate to encrypt this object.
Id (string) --
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
CreatedAt (datetime) --
The time at which the parallel data resource was created.
LastUpdatedAt (datetime) --
The time at which the parallel data resource was last updated.
LatestUpdateAttemptStatus (string) --
The status of the most recent update attempt for the parallel data resource.
LatestUpdateAttemptAt (datetime) --
The time that the most recent update was attempted.
NextToken (string) --
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.
Exceptions
Translate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.InternalServerExceptionLists all tags associated with a given Amazon Translate resource. For more information, see Tagging your resources.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the given Amazon Translate resource you are querying.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
Tags associated with the Amazon Translate resource being queried. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Translate. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Translate.
The initial part of a key-value pair that forms a tag associated with a given resource.
The second part of a key-value pair that forms a tag associated with a given resource.
Exceptions
Translate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.ResourceNotFoundExceptionTranslate.Client.exceptions.InternalServerExceptionlist_terminologies(**kwargs)¶Provides a list of custom terminologies associated with your account.
See also: AWS API Documentation
Request Syntax
response = client.list_terminologies(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'TerminologyPropertiesList': [
{
'Name': 'string',
'Description': 'string',
'Arn': 'string',
'SourceLanguageCode': 'string',
'TargetLanguageCodes': [
'string',
],
'EncryptionKey': {
'Type': 'KMS',
'Id': 'string'
},
'SizeBytes': 123,
'TermCount': 123,
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Directionality': 'UNI'|'MULTI',
'Message': 'string',
'SkippedTermCount': 123,
'Format': 'CSV'|'TMX'|'TSV'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TerminologyPropertiesList (list) --
The properties list of the custom terminologies returned on the list request.
(dict) --
The properties of the custom terminology.
Name (string) --
The name of the custom terminology.
Description (string) --
The description of the custom terminology properties.
Arn (string) --
The Amazon Resource Name (ARN) of the custom terminology.
SourceLanguageCode (string) --
The language code for the source text of the translation request for which the custom terminology is being used.
TargetLanguageCodes (list) --
The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.
EncryptionKey (dict) --
The encryption key for the custom terminology.
Type (string) --
The type of encryption key used by Amazon Translate to encrypt this object.
Id (string) --
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
SizeBytes (integer) --
The size of the file used when importing a custom terminology.
TermCount (integer) --
The number of terms included in the custom terminology.
CreatedAt (datetime) --
The time at which the custom terminology was created, based on the timestamp.
LastUpdatedAt (datetime) --
The time at which the custom terminology was last update, based on the timestamp.
Directionality (string) --
The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
UNI
The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.
MULTI
Any language in the terminology resource can be the source language.
Message (string) --
Additional information from Amazon Translate about the terminology resource.
SkippedTermCount (integer) --
The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.
Format (string) --
The format of the custom terminology input file.
NextToken (string) --
If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies.
Exceptions
Translate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.InternalServerExceptionlist_text_translation_jobs(**kwargs)¶Gets a list of the batch translation jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_text_translation_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmittedBeforeTime': datetime(2015, 1, 1),
'SubmittedAfterTime': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
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.
Filters the list of jobs by name.
Filters the list of jobs based by job status.
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.
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.
dict
Response Syntax
{
'TextTranslationJobPropertiesList': [
{
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'JobDetails': {
'TranslatedDocumentsCount': 123,
'DocumentsWithErrorsCount': 123,
'InputDocumentsCount': 123
},
'SourceLanguageCode': 'string',
'TargetLanguageCodes': [
'string',
],
'TerminologyNames': [
'string',
],
'ParallelDataNames': [
'string',
],
'Message': 'string',
'SubmittedTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'ContentType': 'string'
},
'OutputDataConfig': {
'S3Uri': 'string',
'EncryptionKey': {
'Type': 'KMS',
'Id': 'string'
}
},
'DataAccessRoleArn': 'string',
'Settings': {
'Formality': 'FORMAL'|'INFORMAL',
'Profanity': 'MASK'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TextTranslationJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a translation job.
JobId (string) --
The ID of the translation job.
JobName (string) --
The user-defined name of the translation job.
JobStatus (string) --
The status of the translation job.
JobDetails (dict) --
The number of documents successfully and unsuccessfully processed during the translation job.
TranslatedDocumentsCount (integer) --
The number of documents successfully processed during a translation job.
DocumentsWithErrorsCount (integer) --
The number of documents that could not be processed during a translation job.
InputDocumentsCount (integer) --
The number of documents used as input in a translation job.
SourceLanguageCode (string) --
The language code of the language of the source text. The language must be a language supported by Amazon Translate.
TargetLanguageCodes (list) --
The language code of the language of the target text. The language must be a language supported by Amazon Translate.
TerminologyNames (list) --
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.
ParallelDataNames (list) --
A list containing the names of the parallel data resources applied to the translation job.
Message (string) --
An explanation of any errors that may have occurred during the translation job.
SubmittedTime (datetime) --
The time at which the translation job was submitted.
EndTime (datetime) --
The time at which the translation job ended.
InputDataConfig (dict) --
The input configuration properties that were specified when the job was requested.
S3Uri (string) --
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.
ContentType (string) --
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.Warning
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.
OutputDataConfig (dict) --
The output configuration properties that were specified when the job was requested.
S3Uri (string) --
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 (dict) --
The encryption key used to encrypt this object.
Type (string) --
The type of encryption key used by Amazon Translate to encrypt this object.
Id (string) --
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
DataAccessRoleArn (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.
Settings (dict) --
Settings that configure the translation output.
Formality (string) --
You can optionally 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.
Profanity (string) --
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 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.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Translate.Client.exceptions.InvalidRequestExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.InvalidFilterExceptionTranslate.Client.exceptions.InternalServerExceptionstart_text_translation_job(**kwargs)¶Starts an asynchronous batch translation job. Use batch translation jobs to translate large volumes of text across multiple documents at once. For batch translation, you can input documents with different source languages (specify auto as the source language). You can specify one or more target languages. Batch translation translates each input document into each of the target languages. For more information, see Asynchronous batch processing.
Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.
See also: AWS API Documentation
Request Syntax
response = client.start_text_translation_job(
JobName='string',
InputDataConfig={
'S3Uri': 'string',
'ContentType': 'string'
},
OutputDataConfig={
'S3Uri': 'string',
'EncryptionKey': {
'Type': 'KMS',
'Id': 'string'
}
},
DataAccessRoleArn='string',
SourceLanguageCode='string',
TargetLanguageCodes=[
'string',
],
TerminologyNames=[
'string',
],
ParallelDataNames=[
'string',
],
ClientToken='string',
Settings={
'Formality': 'FORMAL'|'INFORMAL',
'Profanity': 'MASK'
}
)
[REQUIRED]
Specifies the format and location of the input documents for the translation job.
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.
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.Warning
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.
[REQUIRED]
Specifies the S3 folder to which your job output will be saved.
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.
The encryption key used to encrypt this object.
The type of encryption key used by Amazon Translate to encrypt this object.
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
[REQUIRED]
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.
[REQUIRED]
The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto . Amazon Translate auto detects the source language for each input document. For a list of supported language codes, see Supported languages.
[REQUIRED]
The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.
Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.
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.
If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.
For a list of available custom terminology resources, use the ListTerminologies operation.
For more information, see Custom terminology.
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. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.
When you add parallel data to a translation job, you create an Active Custom Translation job.
This parameter accepts only one parallel data resource.
Note
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 your translations with parallel data.
[REQUIRED]
A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.
This field is autopopulated if not provided.
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.
You can optionally 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.
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 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.
dict
Response Syntax
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.
JobStatus (string) --
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.Exceptions
Translate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.UnsupportedLanguagePairExceptionTranslate.Client.exceptions.InvalidRequestExceptionTranslate.Client.exceptions.ResourceNotFoundExceptionTranslate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.InternalServerExceptionstop_text_translation_job(**kwargs)¶Stops an asynchronous batch translation job that is in progress.
If the job's state is IN_PROGRESS , the job will be marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state. Otherwise, the job is put into the STOPPED state.
Asynchronous batch translation jobs are started with the StartTextTranslationJob operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs operations to get a batch translation job's JobId .
See also: AWS API Documentation
Request Syntax
response = client.stop_text_translation_job(
JobId='string'
)
[REQUIRED]
The job ID of the job to be stopped.
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
The job ID of the stopped batch translation job.
The status of the designated job. Upon successful completion, the job's status will be STOPPED .
Exceptions
Translate.Client.exceptions.ResourceNotFoundExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.InternalServerExceptiontag_resource(**kwargs)¶Associates a specific tag with a resource. A tag is a key-value pair that adds as a metadata to a resource. For more information, see Tagging your resources.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the given Amazon Translate resource to which you want to associate the tags.
[REQUIRED]
Tags being associated with a specific Amazon Translate resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.
A key-value pair that adds as a metadata to a resource used by Amazon Translate.
The initial part of a key-value pair that forms a tag associated with a given resource.
The second part of a key-value pair that forms a tag associated with a given resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Translate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.ConcurrentModificationExceptionTranslate.Client.exceptions.ResourceNotFoundExceptionTranslate.Client.exceptions.TooManyTagsExceptionTranslate.Client.exceptions.InternalServerExceptiontranslate_text(**kwargs)¶Translates input text from the source language to the target language. For a list of available languages and language codes, see Supported languages.
See also: AWS API Documentation
Request Syntax
response = client.translate_text(
Text='string',
TerminologyNames=[
'string',
],
SourceLanguageCode='string',
TargetLanguageCode='string',
Settings={
'Formality': 'FORMAL'|'INFORMAL',
'Profanity': 'MASK'
}
)
[REQUIRED]
The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on your character set, this may be fewer than 10,000 characters.
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.
[REQUIRED]
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 Supported 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.
Note
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.
[REQUIRED]
The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.
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.
You can optionally 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.
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 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.
dict
Response Syntax
{
'TranslatedText': 'string',
'SourceLanguageCode': 'string',
'TargetLanguageCode': 'string',
'AppliedTerminologies': [
{
'Name': 'string',
'Terms': [
{
'SourceText': 'string',
'TargetText': 'string'
},
]
},
],
'AppliedSettings': {
'Formality': 'FORMAL'|'INFORMAL',
'Profanity': 'MASK'
}
}
Response Structure
(dict) --
TranslatedText (string) --
The translated text.
SourceLanguageCode (string) --
The language code for the language of the source text.
TargetLanguageCode (string) --
The language code for the language of the target text.
AppliedTerminologies (list) --
The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.
(dict) --
The custom terminology applied to the input text by Amazon Translate for the translated text response. This is optional in the response and will only be present if you specified terminology input in the request. Currently, only one terminology can be applied per TranslateText request.
Name (string) --
The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.
Terms (list) --
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.
(dict) --
The term being translated by the custom terminology.
SourceText (string) --
The source text of the term being translated by the custom terminology.
TargetText (string) --
The target text of the term being translated by the custom terminology.
AppliedSettings (dict) --
Settings that configure the translation output.
Formality (string) --
You can optionally 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.
Profanity (string) --
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 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.
Exceptions
Translate.Client.exceptions.InvalidRequestExceptionTranslate.Client.exceptions.TextSizeLimitExceededExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.UnsupportedLanguagePairExceptionTranslate.Client.exceptions.DetectedLanguageLowConfidenceExceptionTranslate.Client.exceptions.ResourceNotFoundExceptionTranslate.Client.exceptions.InternalServerExceptionTranslate.Client.exceptions.ServiceUnavailableExceptionuntag_resource(**kwargs)¶Removes a specific tag associated with an Amazon Translate resource. For more information, see Tagging your resources.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the given Amazon Translate resource from which you want to remove the tags.
[REQUIRED]
The initial part of a key-value pair that forms a tag being removed from a given resource. Keys must be unique and cannot be duplicated for a particular resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Translate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.ConcurrentModificationExceptionTranslate.Client.exceptions.ResourceNotFoundExceptionTranslate.Client.exceptions.InternalServerExceptionupdate_parallel_data(**kwargs)¶Updates a previously created parallel data resource by importing a new input file from Amazon S3.
See also: AWS API Documentation
Request Syntax
response = client.update_parallel_data(
Name='string',
Description='string',
ParallelDataConfig={
'S3Uri': 'string',
'Format': 'TSV'|'CSV'|'TMX'
},
ClientToken='string'
)
[REQUIRED]
The name of the parallel data resource being updated.
[REQUIRED]
Specifies the format and S3 location of the parallel data input file.
The URI of the Amazon S3 folder that contains the parallel data input file. The folder must be in the same Region as the API endpoint you are calling.
The format of the parallel data input file.
[REQUIRED]
A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Name': 'string',
'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
'LatestUpdateAttemptStatus': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
'LatestUpdateAttemptAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Name (string) --
The name of the parallel data resource being updated.
Status (string) --
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 .
LatestUpdateAttemptStatus (string) --
The status of the parallel data update attempt. When the updated parallel data resource is ready for you to use, the status is ACTIVE .
LatestUpdateAttemptAt (datetime) --
The time that the most recent update was attempted.
Exceptions
Translate.Client.exceptions.ConcurrentModificationExceptionTranslate.Client.exceptions.InvalidParameterValueExceptionTranslate.Client.exceptions.InvalidRequestExceptionTranslate.Client.exceptions.LimitExceededExceptionTranslate.Client.exceptions.TooManyRequestsExceptionTranslate.Client.exceptions.ConflictExceptionTranslate.Client.exceptions.ResourceNotFoundExceptionTranslate.Client.exceptions.InternalServerExceptionThe available paginators are:
Translate.Paginator.ListTerminologies¶paginator = client.get_paginator('list_terminologies')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Translate.Client.list_terminologies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'TerminologyPropertiesList': [
{
'Name': 'string',
'Description': 'string',
'Arn': 'string',
'SourceLanguageCode': 'string',
'TargetLanguageCodes': [
'string',
],
'EncryptionKey': {
'Type': 'KMS',
'Id': 'string'
},
'SizeBytes': 123,
'TermCount': 123,
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Directionality': 'UNI'|'MULTI',
'Message': 'string',
'SkippedTermCount': 123,
'Format': 'CSV'|'TMX'|'TSV'
},
],
}
Response Structure
The properties list of the custom terminologies returned on the list request.
The properties of the custom terminology.
The name of the custom terminology.
The description of the custom terminology properties.
The Amazon Resource Name (ARN) of the custom terminology.
The language code for the source text of the translation request for which the custom terminology is being used.
The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.
The encryption key for the custom terminology.
The type of encryption key used by Amazon Translate to encrypt this object.
The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
The size of the file used when importing a custom terminology.
The number of terms included in the custom terminology.
The time at which the custom terminology was created, based on the timestamp.
The time at which the custom terminology was last update, based on the timestamp.
The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).
UNI
The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.
MULTI
Any language in the terminology resource can be the source language.
Additional information from Amazon Translate about the terminology resource.
The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.
The format of the custom terminology input file.