get_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.InternalServerException