ElementalInference / Paginator / ListDictionaries

ListDictionaries

class ElementalInference.Paginator.ListDictionaries

paginator = client.get_paginator('list_dictionaries')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ElementalInference.Client.list_dictionaries().

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

{
    'dictionaries': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'language': 'eng'|'fra'|'ita'|'deu'|'spa'|'por',
            'status': 'CREATING'|'AVAILABLE'|'REFERENCED'|'DELETING'|'DELETED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • dictionaries (list) –

    A list of DictionarySummary objects.

    • (dict) –

      Contains summary information about a dictionary. Used in the ListDictionaries response.

      • arn (string) –

        The ARN of the dictionary.

      • id (string) –

        The ID of the dictionary.

      • name (string) –

        The name of the dictionary.

      • language (string) –

        The language of the dictionary.

      • status (string) –

        The status of the dictionary.

  • NextToken (string) –

    A token to resume pagination.