Textract / Client / list_adapter_versions

list_adapter_versions#

Textract.Client.list_adapter_versions(**kwargs)#

List all version of an adapter that meet the specified filtration criteria.

See also: AWS API Documentation

Request Syntax

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

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

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

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

    • NextToken (string) –

      Identifies the next page of results to return when listing adapter versions.

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

  • Textract.Client.exceptions.ResourceNotFoundException