Textract / Client / list_adapters

list_adapters#

Textract.Client.list_adapters(**kwargs)#

Lists all adapters that match the specified filtration criteria.

See also: AWS API Documentation

Request Syntax

response = client.list_adapters(
    AfterCreationTime=datetime(2015, 1, 1),
    BeforeCreationTime=datetime(2015, 1, 1),
    MaxResults=123,
    NextToken='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.

  • MaxResults (integer) – The maximum number of results to return when listing adapters.

  • NextToken (string) – Identifies the next page of results to return when listing adapters.

Return type:

dict

Returns:

Response Syntax

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

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) –

    • NextToken (string) –

      Identifies the next page of results to return when listing adapters.

Exceptions

  • Textract.Client.exceptions.InvalidParameterException

  • Textract.Client.exceptions.AccessDeniedException

  • Textract.Client.exceptions.ProvisionedThroughputExceededException

  • Textract.Client.exceptions.InternalServerError

  • Textract.Client.exceptions.ThrottlingException

  • Textract.Client.exceptions.ValidationException