Textract / Client / update_adapter

update_adapter#

Textract.Client.update_adapter(**kwargs)#

Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.

See also: AWS API Documentation

Request Syntax

response = client.update_adapter(
    AdapterId='string',
    Description='string',
    AdapterName='string',
    AutoUpdate='ENABLED'|'DISABLED'
)
Parameters:

  • AdapterId (string) –

    [REQUIRED]

    A string containing a unique ID for the adapter that will be updated.

  • Description (string) – The new description to be applied to the adapter.

  • AdapterName (string) – The new name to be applied to the adapter.

  • AutoUpdate (string) – The new auto-update status to be applied to 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'
}

Response Structure

  • (dict) –

    • AdapterId (string) –

      A string containing a unique ID for the adapter that has been updated.

    • AdapterName (string) –

      A string containing the name of the adapter that has been updated.

    • CreationTime (datetime) –

      An object specifying the creation time of the the adapter that has been updated.

    • Description (string) –

      A string containing the description of the adapter that has been updated.

    • FeatureTypes (list) –

      List of the targeted feature types for the updated adapter.

      • (string) –

    • AutoUpdate (string) –

      The auto-update status of the adapter that has been updated.

Exceptions

  • Textract.Client.exceptions.InvalidParameterException

  • Textract.Client.exceptions.AccessDeniedException

  • Textract.Client.exceptions.ConflictException

  • Textract.Client.exceptions.ProvisionedThroughputExceededException

  • Textract.Client.exceptions.InternalServerError

  • Textract.Client.exceptions.ThrottlingException

  • Textract.Client.exceptions.ValidationException

  • Textract.Client.exceptions.ResourceNotFoundException