AWS API Changes

2021/11/11 - Amazon Translate - 3 updated api methods

Changes This release enables customers to import Multi-Directional Custom Terminology and use Multi-Directional Custom Terminology in both real-time translation and asynchronous batch translation.

GetTerminology (updated)

Link ¶
Changes (request, response)
Request

{'TerminologyDataFormat': {'TSV'}}

Response

{'AuxiliaryDataLocation': {'Location': 'string', 'RepositoryType': 'string'},
 'TerminologyProperties': {'Directionality': 'UNI | MULTI',
                           'Format': 'CSV | TMX | TSV',
                           'Message': 'string',
                           'SkippedTermCount': 'integer'}}

Retrieves a custom terminology.

See also: AWS API Documentation

Request Syntax

client.get_terminology(
    Name='string',
    TerminologyDataFormat='CSV'|'TMX'|'TSV'
)

type Name

string

param Name

[REQUIRED]

The name of the custom terminology being retrieved.

type TerminologyDataFormat

string

param TerminologyDataFormat

The data format of the custom terminology being retrieved.

If you don't specify this parameter, Amazon Translate returns a file that has 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 that of the input file that was imported to create it. Otherwise, Amazon Translate throws an error.

rtype

dict

returns

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.
    - (string) --
  - EncryptionKey (dict) --
    
    The encryption key for the custom terminology.
    - Type (string) --
      
      The type of encryption key used by Amazon Translate to encrypt custom terminologies.
    - Id (string) --
      
      The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
  - 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 data location of the custom terminology being retrieved. The custom terminology file is returned in a presigned url that has a 30 minute expiration.
  - RepositoryType (string) --
    
    The repository type for the custom terminology data.
  - Location (string) --
    
    The location of the custom terminology data.
- 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 location of the custom terminology data.

ImportTerminology (updated)

Link ¶
Changes (request, response)
Request

{'TerminologyData': {'Directionality': 'UNI | MULTI', 'Format': {'TSV'}}}

Response

{'AuxiliaryDataLocation': {'Location': 'string', 'RepositoryType': 'string'},
 'TerminologyProperties': {'Directionality': 'UNI | MULTI',
                           'Format': 'CSV | TMX | TSV',
                           'Message': 'string',
                           'SkippedTermCount': 'integer'}}

Creates or updates a custom terminology, depending on whether or not 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. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name.

If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations.

See also: AWS API Documentation

Request Syntax

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'
    }
)

type Name

string

param Name

[REQUIRED]

The name of the custom terminology being imported.

type MergeStrategy

string

param MergeStrategy

[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.

type Description

string

param Description

The description of the custom terminology being imported.

type TerminologyData

dict

param TerminologyData

[REQUIRED]

The terminology data for the custom terminology being imported.

File (bytes) -- [REQUIRED]

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.
Format (string) -- [REQUIRED]

The data format of the custom terminology.
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 (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 terms in English and Spanish, then it can be used for jobs that translate English to Spanish and jobs that translate 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.

type EncryptionKey

dict

param EncryptionKey

The encryption key for the custom terminology being imported.

Type (string) -- [REQUIRED]

The type of encryption key used by Amazon Translate to encrypt custom terminologies.
Id (string) -- [REQUIRED]

The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.

rtype

dict

returns

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.
    - (string) --
  - EncryptionKey (dict) --
    
    The encryption key for the custom terminology.
    - Type (string) --
      
      The type of encryption key used by Amazon Translate to encrypt custom terminologies.
    - Id (string) --
      
      The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
  - 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 location of the custom terminology data.

ListTerminologies (updated)

Link ¶
Changes (response)

{'TerminologyPropertiesList': {'Directionality': 'UNI | MULTI',
                               'Format': 'CSV | TMX | TSV',
                               'Message': 'string',
                               'SkippedTermCount': 'integer'}}

Provides a list of custom terminologies associated with your account.

See also: AWS API Documentation

Request Syntax

client.list_terminologies(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies.

type MaxResults

integer

param MaxResults

The maximum number of custom terminologies returned per list request.

rtype

dict

returns

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.
      - (string) --
    - EncryptionKey (dict) --
      
      The encryption key for the custom terminology.
      - Type (string) --
        
        The type of encryption key used by Amazon Translate to encrypt custom terminologies.
      - Id (string) --
        
        The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
    - 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.