Textract / Client / get_adapter

get_adapter#

Textract.Client.get_adapter(**kwargs)#

Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.

Request Syntax

response = client.get_adapter(
    AdapterId='string'
)

Parameters:

AdapterId (string) –

[REQUIRED]

A string containing a unique ID for the adapter.

Return type:

dict

Returns:

Response Syntax

{
    'AdapterId': 'string',
    'AdapterName': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'Description': 'string',
    'FeatureTypes': [
        'TABLES'|'FORMS'|'QUERIES'|'SIGNATURES'|'LAYOUT',
    ],
    'AutoUpdate': 'ENABLED'|'DISABLED',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- AdapterId (string) –
  
  A string identifying the adapter that information has been retrieved for.
- AdapterName (string) –
  
  The name of the requested adapter.
- CreationTime (datetime) –
  
  The date and time the requested adapter was created at.
- Description (string) –
  
  The description for the requested adapter.
- FeatureTypes (list) –
  
  List of the targeted feature types for the requested adapter.
  - (string) –
- AutoUpdate (string) –
  
  Binary value indicating if the adapter is being automatically updated or not.
- Tags (dict) –
  
  A set of tags (key-value pairs) associated with the adapter that has been retrieved.
  - (string) –
    - (string) –

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