Translate / Client / list_terminologies

list_terminologies¶

Translate.Client.list_terminologies(**kwargs)¶

Provides a list of custom terminologies associated with your account.

Request Syntax

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

Parameters:

NextToken (string) – If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies.
MaxResults (integer) – The maximum number of custom terminologies returned per list request.

Return type:

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 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.InvalidParameterValueException
Translate.Client.exceptions.TooManyRequestsException
Translate.Client.exceptions.InternalServerException