Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListAdapters

Lists all adapters that match the specified filtration criteria.

Request Syntax


{
   "AfterCreationTime": number,
   "BeforeCreationTime": number,
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

The request accepts the following data in JSON format.

AfterCreationTime

Specifies the lower bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created after the specified creation time.

Type: Timestamp

Required: No

BeforeCreationTime

Specifies the upper bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created before the specified creation time.

Type: Timestamp

Required: No

MaxResults

The maximum number of results to return when listing adapters.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

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

Type: String

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

Pattern: .*\S.*

Required: No

Response Syntax


{
   "Adapters": [ 
      { 
         "AdapterId": "string",
         "AdapterName": "string",
         "CreationTime": number,
         "FeatureTypes": [ "string" ]
      }
   ],
   "NextToken": "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.

Adapters

A list of adapters that matches the filtering criteria specified when calling ListAdapters.

Type: Array of AdapterOverview objects

NextToken

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

Type: String

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

Pattern: .*\S.*

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

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

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