Textract / Paginator / ListAdapters

ListAdapters

class Textract.Paginator.ListAdapters

paginator = client.get_paginator('list_adapters')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Textract.Client.list_adapters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AfterCreationTime=datetime(2015, 1, 1),
    BeforeCreationTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AfterCreationTime (datetime) – Specifies the lower bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created after the specified creation time.

• BeforeCreationTime (datetime) – Specifies the upper bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created before the specified creation time.

• 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

{
    'Adapters': [
        {
            'AdapterId': 'string',
            'AdapterName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'FeatureTypes': [
                'TABLES'|'FORMS'|'QUERIES'|'SIGNATURES'|'LAYOUT',
            ]
        },
    ],

}

Response Structure

• (dict) –

  • Adapters (list) –

    A list of adapters that matches the filtering criteria specified when calling ListAdapters.

    • (dict) –

      Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types.

      • AdapterId (string) –

        A unique identifier for the adapter resource.

      • AdapterName (string) –

        A string naming the adapter resource.

      • CreationTime (datetime) –

        The date and time that the adapter was created.

      • FeatureTypes (list) –

        The feature types that the adapter is operating on.

        • (string) –