Translate / Paginator / ListTerminologies

ListTerminologies

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

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  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.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],

}

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.