Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateAdapter

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

Request Syntax


{
   "AdapterId": "string",
   "AdapterName": "string",
   "AutoUpdate": "string",
   "Description": "string"
}

Request Parameters

The request accepts the following data in JSON format.

AdapterId

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

Type: String

Length Constraints: Minimum length of 12. Maximum length of 1011.

Required: Yes

AdapterName

The new name to be applied to the adapter.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9-_]+

Required: No

AutoUpdate

The new auto-update status to be applied to the adapter.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Description

The new description to be applied to the adapter.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9\s!"\#\$%'&\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$

Required: No

Response Syntax


{
   "AdapterId": "string",
   "AdapterName": "string",
   "AutoUpdate": "string",
   "CreationTime": number,
   "Description": "string",
   "FeatureTypes": [ "string" ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AdapterId

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

Type: String

Length Constraints: Minimum length of 12. Maximum length of 1011.

AdapterName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9-_]+

AutoUpdate

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

Type: String

Valid Values: ENABLED | DISABLED

CreationTime

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

Type: Timestamp

Description

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9\s!"\#\$%'&\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$

FeatureTypes

List of the targeted feature types for the updated adapter.

Type: Array of strings

Valid Values: TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT

Errors

AccessDeniedException

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

HTTP Status Code: 400

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 400

InternalServerError

Amazon Textract experienced a service issue. Try your call again.

HTTP Status Code: 500

InvalidParameterException

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

HTTP Status Code: 400

ProvisionedThroughputExceededException

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

HTTP Status Code: 400

ResourceNotFoundException

Returned when an operation tried to access a nonexistent resource.

HTTP Status Code: 400

ThrottlingException

Amazon Textract is temporarily unable to process the request. Try your call again.

HTTP Status Code: 500

ValidationException

Indicates that a request was not valid. Check request for proper formatting.

HTTP Status Code: 400