Textract / Paginator / ListAdapterVersions

ListAdapterVersions

class Textract.Paginator.ListAdapterVersions

paginator = client.get_paginator('list_adapter_versions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• AdapterId (string) – A string containing a unique ID for the adapter to match for when listing adapter versions.

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

• BeforeCreationTime (datetime) – Specifies the upper bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after 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

{
    'AdapterVersions': [
        {
            'AdapterId': 'string',
            'AdapterVersion': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'FeatureTypes': [
                'TABLES'|'FORMS'|'QUERIES'|'SIGNATURES'|'LAYOUT',
            ],
            'Status': 'ACTIVE'|'AT_RISK'|'DEPRECATED'|'CREATION_ERROR'|'CREATION_IN_PROGRESS',
            'StatusMessage': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • AdapterVersions (list) –

    Adapter versions that match the filtering criteria specified when calling ListAdapters.

    • (dict) –

      Summary info for an adapter version. Contains information on the AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status.

      • AdapterId (string) –

        A unique identifier for the adapter associated with a given adapter version.

      • AdapterVersion (string) –

        An identified for a given adapter version.

      • CreationTime (datetime) –

        The date and time that a given adapter version was created.

      • FeatureTypes (list) –

        The feature types that the adapter version is operating on.

        • (string) –

      • Status (string) –

        Contains information on the status of a given adapter version.

      • StatusMessage (string) –

        A message explaining the status of a given adapter vesion.