# API Reference
<a name="API_Reference"></a>

 This section provides documentation for the Amazon Textract API operations.

**Topics**
+ [Actions](API_Operations.md)
+ [Data Types](API_Types.md)

# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AnalyzeDocument](API_AnalyzeDocument.md) 
+  [AnalyzeExpense](API_AnalyzeExpense.md) 
+  [AnalyzeID](API_AnalyzeID.md) 
+  [CreateAdapter](API_CreateAdapter.md) 
+  [CreateAdapterVersion](API_CreateAdapterVersion.md) 
+  [DeleteAdapter](API_DeleteAdapter.md) 
+  [DeleteAdapterVersion](API_DeleteAdapterVersion.md) 
+  [DetectDocumentText](API_DetectDocumentText.md) 
+  [GetAdapter](API_GetAdapter.md) 
+  [GetAdapterVersion](API_GetAdapterVersion.md) 
+  [GetDocumentAnalysis](API_GetDocumentAnalysis.md) 
+  [GetDocumentTextDetection](API_GetDocumentTextDetection.md) 
+  [GetExpenseAnalysis](API_GetExpenseAnalysis.md) 
+  [GetLendingAnalysis](API_GetLendingAnalysis.md) 
+  [GetLendingAnalysisSummary](API_GetLendingAnalysisSummary.md) 
+  [ListAdapters](API_ListAdapters.md) 
+  [ListAdapterVersions](API_ListAdapterVersions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [StartDocumentAnalysis](API_StartDocumentAnalysis.md) 
+  [StartDocumentTextDetection](API_StartDocumentTextDetection.md) 
+  [StartExpenseAnalysis](API_StartExpenseAnalysis.md) 
+  [StartLendingAnalysis](API_StartLendingAnalysis.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAdapter](API_UpdateAdapter.md) 

# AnalyzeDocument
<a name="API_AnalyzeDocument"></a>

Analyzes an input document for relationships between detected items. 

The types of information returned are as follows: 
+ Form data (key-value pairs). The related information is returned in two [Block](API_Block.md) objects, each of type `KEY_VALUE_SET`: a KEY `Block` object and a VALUE `Block` object. For example, *Name: Ana Silva Carolina* contains a key and value. *Name:* is the key. *Ana Silva Carolina* is the value.
+ Table and table cell data. A TABLE `Block` object contains information about a detected table. A CELL `Block` object is returned for each cell in a table.
+ Lines and words of text. A LINE `Block` object contains one or more WORD `Block` objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of `FeatureTypes`). 
+ Signatures. A SIGNATURE `Block` object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table.
+ Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.
+ Query Result. A QUERY\$1RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION\$1ELEMENT `Block` object contains information about a selection element, including the selection status.

You can choose which type of analysis to perform by specifying the `FeatureTypes` list. 

The output is returned in a list of `Block` objects.

 `AnalyzeDocument` is a synchronous operation. To analyze documents asynchronously, use [StartDocumentAnalysis](API_StartDocumentAnalysis.md).

For more information, see [Document Text Analysis](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).

## Request Syntax
<a name="API_AnalyzeDocument_RequestSyntax"></a>

```
{
   "AdaptersConfig": { 
      "Adapters": [ 
         { 
            "AdapterId": "string",
            "Pages": [ "string" ],
            "Version": "string"
         }
      ]
   },
   "Document": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "FeatureTypes": [ "string" ],
   "HumanLoopConfig": { 
      "DataAttributes": { 
         "ContentClassifiers": [ "string" ]
      },
      "FlowDefinitionArn": "string",
      "HumanLoopName": "string"
   },
   "QueriesConfig": { 
      "Queries": [ 
         { 
            "Alias": "string",
            "Pages": [ "string" ],
            "Text": "string"
         }
      ]
   }
}
```

## Request Parameters
<a name="API_AnalyzeDocument_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AdaptersConfig](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-AdaptersConfig"></a>
Specifies the adapter to be used when analyzing a document.  
Type: [AdaptersConfig](API_AdaptersConfig.md) object  
Required: No

 ** [Document](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-Document"></a>
The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.  
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the `Bytes` field.   
Type: [Document](API_Document.md) object  
Required: Yes

 ** [FeatureTypes](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-FeatureTypes"></a>
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of `FeatureTypes`).   
Type: Array of strings  
Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT`   
Required: Yes

 ** [HumanLoopConfig](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-HumanLoopConfig"></a>
Sets the configuration for the human in the loop workflow for analyzing documents.  
Type: [HumanLoopConfig](API_HumanLoopConfig.md) object  
Required: No

 ** [QueriesConfig](#API_AnalyzeDocument_RequestSyntax) **   <a name="Textract-AnalyzeDocument-request-QueriesConfig"></a>
Contains Queries and the alias for those Queries, as determined by the input.   
Type: [QueriesConfig](API_QueriesConfig.md) object  
Required: No

## Response Syntax
<a name="API_AnalyzeDocument_ResponseSyntax"></a>

```
{
   "AnalyzeDocumentModelVersion": "string",
   "Blocks": [ 
      { 
         "BlockType": "string",
         "ColumnIndex": number,
         "ColumnSpan": number,
         "Confidence": number,
         "EntityTypes": [ "string" ],
         "Geometry": { 
            "BoundingBox": { 
               "Height": number,
               "Left": number,
               "Top": number,
               "Width": number
            },
            "Polygon": [ 
               { 
                  "X": number,
                  "Y": number
               }
            ],
            "RotationAngle": number
         },
         "Id": "string",
         "Page": number,
         "Query": { 
            "Alias": "string",
            "Pages": [ "string" ],
            "Text": "string"
         },
         "Relationships": [ 
            { 
               "Ids": [ "string" ],
               "Type": "string"
            }
         ],
         "RowIndex": number,
         "RowSpan": number,
         "SelectionStatus": "string",
         "Text": "string",
         "TextType": "string"
      }
   ],
   "DocumentMetadata": { 
      "Pages": number
   },
   "HumanLoopActivationOutput": { 
      "HumanLoopActivationConditionsEvaluationResults": "string",
      "HumanLoopActivationReasons": [ "string" ],
      "HumanLoopArn": "string"
   }
}
```

## Response Elements
<a name="API_AnalyzeDocument_ResponseElements"></a>

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

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

 ** [AnalyzeDocumentModelVersion](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-AnalyzeDocumentModelVersion"></a>
The version of the model used to analyze the document.  
Type: String

 ** [Blocks](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-Blocks"></a>
The items that are detected and analyzed by `AnalyzeDocument`.  
Type: Array of [Block](API_Block.md) objects

 ** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-DocumentMetadata"></a>
Metadata about the analyzed document. An example is the number of pages.  
Type: [DocumentMetadata](API_DocumentMetadata.md) object

 ** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) **   <a name="Textract-AnalyzeDocument-response-HumanLoopActivationOutput"></a>
Shows the results of the human in the loop evaluation.  
Type: [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) object

## Errors
<a name="API_AnalyzeDocument_Errors"></a>

 ** 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

 ** BadDocumentException **   
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md).  
HTTP Status Code: 400

 ** DocumentTooLargeException **   
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.  
HTTP Status Code: 400

 ** HumanLoopQuotaExceededException **   
Indicates you have exceeded the maximum number of active human in the loop workflows available    
 ** QuotaCode **   
The quota code.  
 ** ResourceType **   
The resource type.  
 ** ServiceCode **   
The service code.
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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
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

 ** UnsupportedDocumentException **   
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.  
HTTP Status Code: 400

## See Also
<a name="API_AnalyzeDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/AnalyzeDocument) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/AnalyzeDocument) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeDocument) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/AnalyzeDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeDocument) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/AnalyzeDocument) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/AnalyzeDocument) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeDocument) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeDocument) 

# AnalyzeExpense
<a name="API_AnalyzeExpense"></a>

 `AnalyzeExpense` synchronously analyzes an input document for financially related relationships between text.

Information is returned as `ExpenseDocuments` and seperated as follows:
+  `LineItemGroups`- A data set containing `LineItems` which store information about the lines of text, such as an item purchased and its price on a receipt.
+  `SummaryFields`- Contains all other information a receipt, such as header information or the vendors name.

## Request Syntax
<a name="API_AnalyzeExpense_RequestSyntax"></a>

```
{
   "Document": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   }
}
```

## Request Parameters
<a name="API_AnalyzeExpense_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Document](#API_AnalyzeExpense_RequestSyntax) **   <a name="Textract-AnalyzeExpense-request-Document"></a>
The input document, either as bytes or as an S3 object.  
You pass image bytes to an Amazon Textract API operation by using the `Bytes` property. For example, you would use the `Bytes` property to pass a document loaded from a local file system. Image bytes passed by using the `Bytes` property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations.   
You pass images stored in an S3 bucket to an Amazon Textract API operation by using the `S3Object` property. Documents stored in an S3 bucket don't need to be base64 encoded.  
The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.  
If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.  
For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.   
Type: [Document](API_Document.md) object  
Required: Yes

## Response Syntax
<a name="API_AnalyzeExpense_ResponseSyntax"></a>

```
{
   "DocumentMetadata": { 
      "Pages": number
   },
   "ExpenseDocuments": [ 
      { 
         "Blocks": [ 
            { 
               "BlockType": "string",
               "ColumnIndex": number,
               "ColumnSpan": number,
               "Confidence": number,
               "EntityTypes": [ "string" ],
               "Geometry": { 
                  "BoundingBox": { 
                     "Height": number,
                     "Left": number,
                     "Top": number,
                     "Width": number
                  },
                  "Polygon": [ 
                     { 
                        "X": number,
                        "Y": number
                     }
                  ],
                  "RotationAngle": number
               },
               "Id": "string",
               "Page": number,
               "Query": { 
                  "Alias": "string",
                  "Pages": [ "string" ],
                  "Text": "string"
               },
               "Relationships": [ 
                  { 
                     "Ids": [ "string" ],
                     "Type": "string"
                  }
               ],
               "RowIndex": number,
               "RowSpan": number,
               "SelectionStatus": "string",
               "Text": "string",
               "TextType": "string"
            }
         ],
         "ExpenseIndex": number,
         "LineItemGroups": [ 
            { 
               "LineItemGroupIndex": number,
               "LineItems": [ 
                  { 
                     "LineItemExpenseFields": [ 
                        { 
                           "Currency": { 
                              "Code": "string",
                              "Confidence": number
                           },
                           "GroupProperties": [ 
                              { 
                                 "Id": "string",
                                 "Types": [ "string" ]
                              }
                           ],
                           "LabelDetection": { 
                              "Confidence": number,
                              "Geometry": { 
                                 "BoundingBox": { 
                                    "Height": number,
                                    "Left": number,
                                    "Top": number,
                                    "Width": number
                                 },
                                 "Polygon": [ 
                                    { 
                                       "X": number,
                                       "Y": number
                                    }
                                 ],
                                 "RotationAngle": number
                              },
                              "Text": "string"
                           },
                           "PageNumber": number,
                           "Type": { 
                              "Confidence": number,
                              "Text": "string"
                           },
                           "ValueDetection": { 
                              "Confidence": number,
                              "Geometry": { 
                                 "BoundingBox": { 
                                    "Height": number,
                                    "Left": number,
                                    "Top": number,
                                    "Width": number
                                 },
                                 "Polygon": [ 
                                    { 
                                       "X": number,
                                       "Y": number
                                    }
                                 ],
                                 "RotationAngle": number
                              },
                              "Text": "string"
                           }
                        }
                     ]
                  }
               ]
            }
         ],
         "SummaryFields": [ 
            { 
               "Currency": { 
                  "Code": "string",
                  "Confidence": number
               },
               "GroupProperties": [ 
                  { 
                     "Id": "string",
                     "Types": [ "string" ]
                  }
               ],
               "LabelDetection": { 
                  "Confidence": number,
                  "Geometry": { 
                     "BoundingBox": { 
                        "Height": number,
                        "Left": number,
                        "Top": number,
                        "Width": number
                     },
                     "Polygon": [ 
                        { 
                           "X": number,
                           "Y": number
                        }
                     ],
                     "RotationAngle": number
                  },
                  "Text": "string"
               },
               "PageNumber": number,
               "Type": { 
                  "Confidence": number,
                  "Text": "string"
               },
               "ValueDetection": { 
                  "Confidence": number,
                  "Geometry": { 
                     "BoundingBox": { 
                        "Height": number,
                        "Left": number,
                        "Top": number,
                        "Width": number
                     },
                     "Polygon": [ 
                        { 
                           "X": number,
                           "Y": number
                        }
                     ],
                     "RotationAngle": number
                  },
                  "Text": "string"
               }
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_AnalyzeExpense_ResponseElements"></a>

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

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

 ** [DocumentMetadata](#API_AnalyzeExpense_ResponseSyntax) **   <a name="Textract-AnalyzeExpense-response-DocumentMetadata"></a>
Information about the input document.  
Type: [DocumentMetadata](API_DocumentMetadata.md) object

 ** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) **   <a name="Textract-AnalyzeExpense-response-ExpenseDocuments"></a>
The expenses detected by Amazon Textract.  
Type: Array of [ExpenseDocument](API_ExpenseDocument.md) objects

## Errors
<a name="API_AnalyzeExpense_Errors"></a>

 ** 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

 ** BadDocumentException **   
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md).  
HTTP Status Code: 400

 ** DocumentTooLargeException **   
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.  
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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
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

 ** UnsupportedDocumentException **   
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.  
HTTP Status Code: 400

## See Also
<a name="API_AnalyzeExpense_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/AnalyzeExpense) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/AnalyzeExpense) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeExpense) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/AnalyzeExpense) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeExpense) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/AnalyzeExpense) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/AnalyzeExpense) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeExpense) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeExpense) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeExpense) 

# AnalyzeID
<a name="API_AnalyzeID"></a>

Analyzes identity documents for relevant information. This information is extracted and returned as `IdentityDocumentFields`, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, `AnalyzeID` doesn't return any Geometry data.

## Request Syntax
<a name="API_AnalyzeID_RequestSyntax"></a>

```
{
   "DocumentPages": [ 
      { 
         "Bytes": blob,
         "S3Object": { 
            "Bucket": "string",
            "Name": "string",
            "Version": "string"
         }
      }
   ]
}
```

## Request Parameters
<a name="API_AnalyzeID_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DocumentPages](#API_AnalyzeID_RequestSyntax) **   <a name="Textract-AnalyzeID-request-DocumentPages"></a>
The document being passed to AnalyzeID.  
Type: Array of [Document](API_Document.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Required: Yes

## Response Syntax
<a name="API_AnalyzeID_ResponseSyntax"></a>

```
{
   "AnalyzeIDModelVersion": "string",
   "DocumentMetadata": { 
      "Pages": number
   },
   "IdentityDocuments": [ 
      { 
         "Blocks": [ 
            { 
               "BlockType": "string",
               "ColumnIndex": number,
               "ColumnSpan": number,
               "Confidence": number,
               "EntityTypes": [ "string" ],
               "Geometry": { 
                  "BoundingBox": { 
                     "Height": number,
                     "Left": number,
                     "Top": number,
                     "Width": number
                  },
                  "Polygon": [ 
                     { 
                        "X": number,
                        "Y": number
                     }
                  ],
                  "RotationAngle": number
               },
               "Id": "string",
               "Page": number,
               "Query": { 
                  "Alias": "string",
                  "Pages": [ "string" ],
                  "Text": "string"
               },
               "Relationships": [ 
                  { 
                     "Ids": [ "string" ],
                     "Type": "string"
                  }
               ],
               "RowIndex": number,
               "RowSpan": number,
               "SelectionStatus": "string",
               "Text": "string",
               "TextType": "string"
            }
         ],
         "DocumentIndex": number,
         "IdentityDocumentFields": [ 
            { 
               "Type": { 
                  "Confidence": number,
                  "NormalizedValue": { 
                     "Value": "string",
                     "ValueType": "string"
                  },
                  "Text": "string"
               },
               "ValueDetection": { 
                  "Confidence": number,
                  "NormalizedValue": { 
                     "Value": "string",
                     "ValueType": "string"
                  },
                  "Text": "string"
               }
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_AnalyzeID_ResponseElements"></a>

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

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

 ** [AnalyzeIDModelVersion](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-AnalyzeIDModelVersion"></a>
The version of the AnalyzeIdentity API being used to process documents.  
Type: String

 ** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-DocumentMetadata"></a>
Information about the input document.  
Type: [DocumentMetadata](API_DocumentMetadata.md) object

 ** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) **   <a name="Textract-AnalyzeID-response-IdentityDocuments"></a>
The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.  
Type: Array of [IdentityDocument](API_IdentityDocument.md) objects

## Errors
<a name="API_AnalyzeID_Errors"></a>

 ** 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

 ** BadDocumentException **   
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md).  
HTTP Status Code: 400

 ** DocumentTooLargeException **   
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.  
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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
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

 ** UnsupportedDocumentException **   
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.  
HTTP Status Code: 400

## See Also
<a name="API_AnalyzeID_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/AnalyzeID) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/AnalyzeID) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeID) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/AnalyzeID) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeID) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/AnalyzeID) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/AnalyzeID) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeID) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeID) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeID) 

# CreateAdapter
<a name="API_CreateAdapter"></a>

Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is `QUERIES`. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.

## Request Syntax
<a name="API_CreateAdapter_RequestSyntax"></a>

```
{
   "AdapterName": "string",
   "AutoUpdate": "string",
   "ClientRequestToken": "string",
   "Description": "string",
   "FeatureTypes": [ "string" ],
   "Tags": { 
      "string" : "string" 
   }
}
```

## Request Parameters
<a name="API_CreateAdapter_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AdapterName](#API_CreateAdapter_RequestSyntax) **   <a name="Textract-CreateAdapter-request-AdapterName"></a>
The name to be assigned to the adapter being created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9-_]+`   
Required: Yes

 ** [AutoUpdate](#API_CreateAdapter_RequestSyntax) **   <a name="Textract-CreateAdapter-request-AutoUpdate"></a>
Controls whether or not the adapter should automatically update.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [ClientRequestToken](#API_CreateAdapter_RequestSyntax) **   <a name="Textract-CreateAdapter-request-ClientRequestToken"></a>
Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$`   
Required: No

 ** [Description](#API_CreateAdapter_RequestSyntax) **   <a name="Textract-CreateAdapter-request-Description"></a>
The description to be assigned to the adapter being created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$`   
Required: No

 ** [FeatureTypes](#API_CreateAdapter_RequestSyntax) **   <a name="Textract-CreateAdapter-request-FeatureTypes"></a>
The type of feature that the adapter is being trained on. Currrenly, supported feature types are: `QUERIES`   
Type: Array of strings  
Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT`   
Required: Yes

 ** [Tags](#API_CreateAdapter_RequestSyntax) **   <a name="Textract-CreateAdapter-request-Tags"></a>
A list of tags to be added to the adapter.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

## Response Syntax
<a name="API_CreateAdapter_ResponseSyntax"></a>

```
{
   "AdapterId": "string"
}
```

## Response Elements
<a name="API_CreateAdapter_ResponseElements"></a>

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](#API_CreateAdapter_ResponseSyntax) **   <a name="Textract-CreateAdapter-response-AdapterId"></a>
A string containing the unique ID for the adapter that has been created.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.

## Errors
<a name="API_CreateAdapter_Errors"></a>

 ** 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

 ** IdempotentParameterMismatchException **   
A `ClientRequestToken` input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to 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

 ** LimitExceededException **   
An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (`StartDocumentTextDetection`, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.   
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

 ** ServiceQuotaExceededException **   
Returned when a request cannot be completed as it would exceed a maximum service quota.  
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

## See Also
<a name="API_CreateAdapter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/CreateAdapter) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/CreateAdapter) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/CreateAdapter) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/CreateAdapter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/CreateAdapter) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/CreateAdapter) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/CreateAdapter) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/CreateAdapter) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/CreateAdapter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/CreateAdapter) 

# CreateAdapterVersion
<a name="API_CreateAdapterVersion"></a>

Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.

## Request Syntax
<a name="API_CreateAdapterVersion_RequestSyntax"></a>

```
{
   "AdapterId": "string",
   "ClientRequestToken": "string",
   "DatasetConfig": { 
      "ManifestS3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "KMSKeyId": "string",
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## Request Parameters
<a name="API_CreateAdapterVersion_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AdapterId](#API_CreateAdapterVersion_RequestSyntax) **   <a name="Textract-CreateAdapterVersion-request-AdapterId"></a>
A string containing a unique ID for the adapter that will receive a new version.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.  
Required: Yes

 ** [ClientRequestToken](#API_CreateAdapterVersion_RequestSyntax) **   <a name="Textract-CreateAdapterVersion-request-ClientRequestToken"></a>
Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapterVersion requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$`   
Required: No

 ** [DatasetConfig](#API_CreateAdapterVersion_RequestSyntax) **   <a name="Textract-CreateAdapterVersion-request-DatasetConfig"></a>
Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the value.  
Type: [AdapterVersionDatasetConfig](API_AdapterVersionDatasetConfig.md) object  
Required: Yes

 ** [KMSKeyId](#API_CreateAdapterVersion_RequestSyntax) **   <a name="Textract-CreateAdapterVersion-request-KMSKeyId"></a>
The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
Required: No

 ** [OutputConfig](#API_CreateAdapterVersion_RequestSyntax) **   <a name="Textract-CreateAdapterVersion-request-OutputConfig"></a>
Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.  
 `OutputConfig` is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With `OutputConfig` enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the `KMSKeyID` parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.  
Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see [ Managing AI services opt-out policy. ](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html)   
For more information on data privacy, see the [Data Privacy FAQ](https://aws.amazon.com/compliance/data-privacy-faq/).  
Type: [OutputConfig](API_OutputConfig.md) object  
Required: Yes

 ** [Tags](#API_CreateAdapterVersion_RequestSyntax) **   <a name="Textract-CreateAdapterVersion-request-Tags"></a>
A set of tags (key-value pairs) that you want to attach to the adapter version.   
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

## Response Syntax
<a name="API_CreateAdapterVersion_ResponseSyntax"></a>

```
{
   "AdapterId": "string",
   "AdapterVersion": "string"
}
```

## Response Elements
<a name="API_CreateAdapterVersion_ResponseElements"></a>

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](#API_CreateAdapterVersion_ResponseSyntax) **   <a name="Textract-CreateAdapterVersion-response-AdapterId"></a>
A string containing the unique ID for the adapter that has received a new version.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.

 ** [AdapterVersion](#API_CreateAdapterVersion_ResponseSyntax) **   <a name="Textract-CreateAdapterVersion-response-AdapterVersion"></a>
A string describing the new version of the adapter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

## Errors
<a name="API_CreateAdapterVersion_Errors"></a>

 ** 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

 ** IdempotentParameterMismatchException **   
A `ClientRequestToken` input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.   
HTTP Status Code: 400

 ** InternalServerError **   
Amazon Textract experienced a service issue. Try your call again.  
HTTP Status Code: 500

 ** InvalidKMSKeyException **   
 Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.   
HTTP Status Code: 400

 ** 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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
HTTP Status Code: 400

 ** LimitExceededException **   
An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (`StartDocumentTextDetection`, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.   
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

 ** ServiceQuotaExceededException **   
Returned when a request cannot be completed as it would exceed a maximum service quota.  
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

## See Also
<a name="API_CreateAdapterVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/CreateAdapterVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/CreateAdapterVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/CreateAdapterVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/CreateAdapterVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/CreateAdapterVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/CreateAdapterVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/CreateAdapterVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/CreateAdapterVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/CreateAdapterVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/CreateAdapterVersion) 

# DeleteAdapter
<a name="API_DeleteAdapter"></a>

Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.

## Request Syntax
<a name="API_DeleteAdapter_RequestSyntax"></a>

```
{
   "AdapterId": "string"
}
```

## Request Parameters
<a name="API_DeleteAdapter_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AdapterId](#API_DeleteAdapter_RequestSyntax) **   <a name="Textract-DeleteAdapter-request-AdapterId"></a>
A string containing a unique ID for the adapter to be deleted.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.  
Required: Yes

## Response Elements
<a name="API_DeleteAdapter_ResponseElements"></a>

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

## Errors
<a name="API_DeleteAdapter_Errors"></a>

 ** 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

## See Also
<a name="API_DeleteAdapter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/DeleteAdapter) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/DeleteAdapter) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DeleteAdapter) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/DeleteAdapter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DeleteAdapter) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/DeleteAdapter) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/DeleteAdapter) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DeleteAdapter) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DeleteAdapter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DeleteAdapter) 

# DeleteAdapterVersion
<a name="API_DeleteAdapterVersion"></a>

Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.

## Request Syntax
<a name="API_DeleteAdapterVersion_RequestSyntax"></a>

```
{
   "AdapterId": "string",
   "AdapterVersion": "string"
}
```

## Request Parameters
<a name="API_DeleteAdapterVersion_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AdapterId](#API_DeleteAdapterVersion_RequestSyntax) **   <a name="Textract-DeleteAdapterVersion-request-AdapterId"></a>
A string containing a unique ID for the adapter version that will be deleted.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.  
Required: Yes

 ** [AdapterVersion](#API_DeleteAdapterVersion_RequestSyntax) **   <a name="Textract-DeleteAdapterVersion-request-AdapterVersion"></a>
Specifies the adapter version to be deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements
<a name="API_DeleteAdapterVersion_ResponseElements"></a>

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

## Errors
<a name="API_DeleteAdapterVersion_Errors"></a>

 ** 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

## See Also
<a name="API_DeleteAdapterVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/DeleteAdapterVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/DeleteAdapterVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DeleteAdapterVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/DeleteAdapterVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DeleteAdapterVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/DeleteAdapterVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/DeleteAdapterVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DeleteAdapterVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DeleteAdapterVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DeleteAdapterVersion) 

# DetectDocumentText
<a name="API_DetectDocumentText"></a>

Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. `DetectDocumentText` returns the detected text in an array of [Block](API_Block.md) objects. 

Each document page has as an associated `Block` of type PAGE. Each PAGE `Block` object is the parent of LINE `Block` objects that represent the lines of detected text on a page. A LINE `Block` object is a parent for each word that makes up the line. Words are represented by `Block` objects of type WORD.

 `DetectDocumentText` is a synchronous operation. To analyze documents asynchronously, use [StartDocumentTextDetection](API_StartDocumentTextDetection.md).

For more information, see [Document Text Detection](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

## Request Syntax
<a name="API_DetectDocumentText_RequestSyntax"></a>

```
{
   "Document": { 
      "Bytes": blob,
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   }
}
```

## Request Parameters
<a name="API_DetectDocumentText_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Document](#API_DetectDocumentText_RequestSyntax) **   <a name="Textract-DetectDocumentText-request-Document"></a>
The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.  
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the `Bytes` field.   
Type: [Document](API_Document.md) object  
Required: Yes

## Response Syntax
<a name="API_DetectDocumentText_ResponseSyntax"></a>

```
{
   "Blocks": [ 
      { 
         "BlockType": "string",
         "ColumnIndex": number,
         "ColumnSpan": number,
         "Confidence": number,
         "EntityTypes": [ "string" ],
         "Geometry": { 
            "BoundingBox": { 
               "Height": number,
               "Left": number,
               "Top": number,
               "Width": number
            },
            "Polygon": [ 
               { 
                  "X": number,
                  "Y": number
               }
            ],
            "RotationAngle": number
         },
         "Id": "string",
         "Page": number,
         "Query": { 
            "Alias": "string",
            "Pages": [ "string" ],
            "Text": "string"
         },
         "Relationships": [ 
            { 
               "Ids": [ "string" ],
               "Type": "string"
            }
         ],
         "RowIndex": number,
         "RowSpan": number,
         "SelectionStatus": "string",
         "Text": "string",
         "TextType": "string"
      }
   ],
   "DetectDocumentTextModelVersion": "string",
   "DocumentMetadata": { 
      "Pages": number
   }
}
```

## Response Elements
<a name="API_DetectDocumentText_ResponseElements"></a>

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

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

 ** [Blocks](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-Blocks"></a>
An array of `Block` objects that contain the text that's detected in the document.  
Type: Array of [Block](API_Block.md) objects

 ** [DetectDocumentTextModelVersion](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-DetectDocumentTextModelVersion"></a>
  
Type: String

 ** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) **   <a name="Textract-DetectDocumentText-response-DocumentMetadata"></a>
Metadata about the document. It contains the number of pages that are detected in the document.  
Type: [DocumentMetadata](API_DocumentMetadata.md) object

## Errors
<a name="API_DetectDocumentText_Errors"></a>

 ** 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

 ** BadDocumentException **   
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md).  
HTTP Status Code: 400

 ** DocumentTooLargeException **   
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.  
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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
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

 ** UnsupportedDocumentException **   
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.  
HTTP Status Code: 400

## See Also
<a name="API_DetectDocumentText_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/DetectDocumentText) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/DetectDocumentText) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DetectDocumentText) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/DetectDocumentText) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DetectDocumentText) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/DetectDocumentText) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/DetectDocumentText) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DetectDocumentText) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DetectDocumentText) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DetectDocumentText) 

# GetAdapter
<a name="API_GetAdapter"></a>

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

## Request Syntax
<a name="API_GetAdapter_RequestSyntax"></a>

```
{
   "AdapterId": "string"
}
```

## Request Parameters
<a name="API_GetAdapter_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AdapterId](#API_GetAdapter_RequestSyntax) **   <a name="Textract-GetAdapter-request-AdapterId"></a>
A string containing a unique ID for the adapter.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.  
Required: Yes

## Response Syntax
<a name="API_GetAdapter_ResponseSyntax"></a>

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

## Response Elements
<a name="API_GetAdapter_ResponseElements"></a>

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](#API_GetAdapter_ResponseSyntax) **   <a name="Textract-GetAdapter-response-AdapterId"></a>
A string identifying the adapter that information has been retrieved for.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.

 ** [AdapterName](#API_GetAdapter_ResponseSyntax) **   <a name="Textract-GetAdapter-response-AdapterName"></a>
The name of the requested adapter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9-_]+` 

 ** [AutoUpdate](#API_GetAdapter_ResponseSyntax) **   <a name="Textract-GetAdapter-response-AutoUpdate"></a>
Binary value indicating if the adapter is being automatically updated or not.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [CreationTime](#API_GetAdapter_ResponseSyntax) **   <a name="Textract-GetAdapter-response-CreationTime"></a>
The date and time the requested adapter was created at.  
Type: Timestamp

 ** [Description](#API_GetAdapter_ResponseSyntax) **   <a name="Textract-GetAdapter-response-Description"></a>
The description for the requested adapter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$` 

 ** [FeatureTypes](#API_GetAdapter_ResponseSyntax) **   <a name="Textract-GetAdapter-response-FeatureTypes"></a>
List of the targeted feature types for the requested adapter.  
Type: Array of strings  
Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT` 

 ** [Tags](#API_GetAdapter_ResponseSyntax) **   <a name="Textract-GetAdapter-response-Tags"></a>
A set of tags (key-value pairs) associated with the adapter that has been retrieved.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 

## Errors
<a name="API_GetAdapter_Errors"></a>

 ** 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

 ** 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

## See Also
<a name="API_GetAdapter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetAdapter) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetAdapter) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetAdapter) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetAdapter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetAdapter) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetAdapter) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetAdapter) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetAdapter) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetAdapter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetAdapter) 

# GetAdapterVersion
<a name="API_GetAdapterVersion"></a>

Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

## Request Syntax
<a name="API_GetAdapterVersion_RequestSyntax"></a>

```
{
   "AdapterId": "string",
   "AdapterVersion": "string"
}
```

## Request Parameters
<a name="API_GetAdapterVersion_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AdapterId](#API_GetAdapterVersion_RequestSyntax) **   <a name="Textract-GetAdapterVersion-request-AdapterId"></a>
A string specifying a unique ID for the adapter version you want to retrieve information for.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.  
Required: Yes

 ** [AdapterVersion](#API_GetAdapterVersion_RequestSyntax) **   <a name="Textract-GetAdapterVersion-request-AdapterVersion"></a>
A string specifying the adapter version you want to retrieve information for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Syntax
<a name="API_GetAdapterVersion_ResponseSyntax"></a>

```
{
   "AdapterId": "string",
   "AdapterVersion": "string",
   "CreationTime": number,
   "DatasetConfig": { 
      "ManifestS3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "EvaluationMetrics": [ 
      { 
         "AdapterVersion": { 
            "F1Score": number,
            "Precision": number,
            "Recall": number
         },
         "Baseline": { 
            "F1Score": number,
            "Precision": number,
            "Recall": number
         },
         "FeatureType": "string"
      }
   ],
   "FeatureTypes": [ "string" ],
   "KMSKeyId": "string",
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   },
   "Status": "string",
   "StatusMessage": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetAdapterVersion_ResponseElements"></a>

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](#API_GetAdapterVersion_ResponseSyntax) **   <a name="Textract-GetAdapterVersion-response-AdapterId"></a>
A string containing a unique ID for the adapter version being retrieved.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.

 ** [AdapterVersion](#API_GetAdapterVersion_ResponseSyntax) **   <a name="Textract-GetAdapterVersion-response-AdapterVersion"></a>
A string containing the adapter version that has been retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [CreationTime](#API_GetAdapterVersion_ResponseSyntax) **   <a name="Textract-GetAdapterVersion-response-CreationTime"></a>
The time that the adapter version was created.  
Type: Timestamp

 ** [DatasetConfig](#API_GetAdapterVersion_ResponseSyntax) **   <a name="Textract-GetAdapterVersion-response-DatasetConfig"></a>
Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.  
Type: [AdapterVersionDatasetConfig](API_AdapterVersionDatasetConfig.md) object

 ** [EvaluationMetrics](#API_GetAdapterVersion_ResponseSyntax) **   <a name="Textract-GetAdapterVersion-response-EvaluationMetrics"></a>
The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.  
Type: Array of [AdapterVersionEvaluationMetric](API_AdapterVersionEvaluationMetric.md) objects

 ** [FeatureTypes](#API_GetAdapterVersion_ResponseSyntax) **   <a name="Textract-GetAdapterVersion-response-FeatureTypes"></a>
List of the targeted feature types for the requested adapter version.  
Type: Array of strings  
Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT` 

 ** [KMSKeyId](#API_GetAdapterVersion_ResponseSyntax) **   <a name="Textract-GetAdapterVersion-response-KMSKeyId"></a>
The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` 

 ** [OutputConfig](#API_GetAdapterVersion_ResponseSyntax) **   <a name="Textract-GetAdapterVersion-response-OutputConfig"></a>
Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.  
 `OutputConfig` is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With `OutputConfig` enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the `KMSKeyID` parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.  
Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see [ Managing AI services opt-out policy. ](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html)   
For more information on data privacy, see the [Data Privacy FAQ](https://aws.amazon.com/compliance/data-privacy-faq/).  
Type: [OutputConfig](API_OutputConfig.md) object

 ** [Status](#API_GetAdapterVersion_ResponseSyntax) **   <a name="Textract-GetAdapterVersion-response-Status"></a>
The status of the adapter version that has been requested.  
Type: String  
Valid Values: `ACTIVE | AT_RISK | DEPRECATED | CREATION_ERROR | CREATION_IN_PROGRESS` 

 ** [StatusMessage](#API_GetAdapterVersion_ResponseSyntax) **   <a name="Textract-GetAdapterVersion-response-StatusMessage"></a>
A message that describes the status of the requested adapter version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$` 

 ** [Tags](#API_GetAdapterVersion_ResponseSyntax) **   <a name="Textract-GetAdapterVersion-response-Tags"></a>
A set of tags (key-value pairs) that are associated with the adapter version.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 

## Errors
<a name="API_GetAdapterVersion_Errors"></a>

 ** 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

 ** 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

## See Also
<a name="API_GetAdapterVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetAdapterVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetAdapterVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetAdapterVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetAdapterVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetAdapterVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetAdapterVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetAdapterVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetAdapterVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetAdapterVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetAdapterVersion) 

# GetDocumentAnalysis
<a name="API_GetDocumentAnalysis"></a>

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

You start asynchronous text analysis by calling [StartDocumentAnalysis](API_StartDocumentAnalysis.md), which returns a job identifier (`JobId`). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to `StartDocumentAnalysis`. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call `GetDocumentAnalysis`, and pass the job identifier (`JobId`) from the initial call to `StartDocumentAnalysis`.

 `GetDocumentAnalysis` returns an array of [Block](API_Block.md) objects. The following types of information are returned: 
+ Form data (key-value pairs). The related information is returned in two [Block](API_Block.md) objects, each of type `KEY_VALUE_SET`: a KEY `Block` object and a VALUE `Block` object. For example, *Name: Ana Silva Carolina* contains a key and value. *Name:* is the key. *Ana Silva Carolina* is the value.
+ Table and table cell data. A TABLE `Block` object contains information about a detected table. A CELL `Block` object is returned for each cell in a table.
+ Lines and words of text. A LINE `Block` object contains one or more WORD `Block` objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the `StartDocumentAnalysis` `FeatureTypes` input parameter). 
+ Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.
+ Query Results. A QUERY\$1RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

**Note**  
While processing a document with queries, look out for `INVALID_REQUEST_PARAMETERS` output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist. 

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION\$1ELEMENT `Block` object contains information about a selection element, including the selection status.

Use the `MaxResults` parameter to limit the number of blocks that are returned. If there are more results than specified in `MaxResults`, the value of `NextToken` in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call `GetDocumentAnalysis`, and populate the `NextToken` request parameter with the token value that's returned from the previous call to `GetDocumentAnalysis`.

For more information, see [Document Text Analysis](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).

## Request Syntax
<a name="API_GetDocumentAnalysis_RequestSyntax"></a>

```
{
   "JobId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_GetDocumentAnalysis_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [JobId](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-JobId"></a>
A unique identifier for the text-detection job. The `JobId` is returned from `StartDocumentAnalysis`. A `JobId` value is only valid for 7 days.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$`   
Required: Yes

 ** [MaxResults](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-MaxResults"></a>
The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [NextToken](#API_GetDocumentAnalysis_RequestSyntax) **   <a name="Textract-GetDocumentAnalysis-request-NextToken"></a>
If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*`   
Required: No

## Response Syntax
<a name="API_GetDocumentAnalysis_ResponseSyntax"></a>

```
{
   "AnalyzeDocumentModelVersion": "string",
   "Blocks": [ 
      { 
         "BlockType": "string",
         "ColumnIndex": number,
         "ColumnSpan": number,
         "Confidence": number,
         "EntityTypes": [ "string" ],
         "Geometry": { 
            "BoundingBox": { 
               "Height": number,
               "Left": number,
               "Top": number,
               "Width": number
            },
            "Polygon": [ 
               { 
                  "X": number,
                  "Y": number
               }
            ],
            "RotationAngle": number
         },
         "Id": "string",
         "Page": number,
         "Query": { 
            "Alias": "string",
            "Pages": [ "string" ],
            "Text": "string"
         },
         "Relationships": [ 
            { 
               "Ids": [ "string" ],
               "Type": "string"
            }
         ],
         "RowIndex": number,
         "RowSpan": number,
         "SelectionStatus": "string",
         "Text": "string",
         "TextType": "string"
      }
   ],
   "DocumentMetadata": { 
      "Pages": number
   },
   "JobStatus": "string",
   "NextToken": "string",
   "StatusMessage": "string",
   "Warnings": [ 
      { 
         "ErrorCode": "string",
         "Pages": [ number ]
      }
   ]
}
```

## Response Elements
<a name="API_GetDocumentAnalysis_ResponseElements"></a>

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

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

 ** [AnalyzeDocumentModelVersion](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-AnalyzeDocumentModelVersion"></a>
  
Type: String

 ** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-Blocks"></a>
The results of the text-analysis operation.  
Type: Array of [Block](API_Block.md) objects

 ** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-DocumentMetadata"></a>
Information about a document that Amazon Textract processed. `DocumentMetadata` is returned in every page of paginated responses from an Amazon Textract video operation.  
Type: [DocumentMetadata](API_DocumentMetadata.md) object

 ** [JobStatus](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-JobStatus"></a>
The current status of the text detection job.  
Type: String  
Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-NextToken"></a>
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*` 

 ** [StatusMessage](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-StatusMessage"></a>
Returns if the detection job could not be completed. Contains explanation for what error occured.  
Type: String

 ** [Warnings](#API_GetDocumentAnalysis_ResponseSyntax) **   <a name="Textract-GetDocumentAnalysis-response-Warnings"></a>
A list of warnings that occurred during the document-analysis operation.  
Type: Array of [Warning](API_Warning.md) objects

## Errors
<a name="API_GetDocumentAnalysis_Errors"></a>

 ** 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

 ** InvalidJobIdException **   
An invalid job identifier was passed to an asynchronous analysis operation.  
HTTP Status Code: 400

 ** InvalidKMSKeyException **   
 Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.   
HTTP Status Code: 400

 ** 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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
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

## See Also
<a name="API_GetDocumentAnalysis_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentAnalysis) 

# GetDocumentTextDetection
<a name="API_GetDocumentTextDetection"></a>

Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

You start asynchronous text detection by calling [StartDocumentTextDetection](API_StartDocumentTextDetection.md), which returns a job identifier (`JobId`). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to `StartDocumentTextDetection`. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call `GetDocumentTextDetection`, and pass the job identifier (`JobId`) from the initial call to `StartDocumentTextDetection`.

 `GetDocumentTextDetection` returns an array of [Block](API_Block.md) objects. 

Each document page has as an associated `Block` of type PAGE. Each PAGE `Block` object is the parent of LINE `Block` objects that represent the lines of detected text on a page. A LINE `Block` object is a parent for each word that makes up the line. Words are represented by `Block` objects of type WORD.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in `MaxResults`, the value of `NextToken` in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call `GetDocumentTextDetection`, and populate the `NextToken` request parameter with the token value that's returned from the previous call to `GetDocumentTextDetection`.

For more information, see [Document Text Detection](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

## Request Syntax
<a name="API_GetDocumentTextDetection_RequestSyntax"></a>

```
{
   "JobId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_GetDocumentTextDetection_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [JobId](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-JobId"></a>
A unique identifier for the text detection job. The `JobId` is returned from `StartDocumentTextDetection`. A `JobId` value is only valid for 7 days.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$`   
Required: Yes

 ** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-MaxResults"></a>
The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) **   <a name="Textract-GetDocumentTextDetection-request-NextToken"></a>
If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*`   
Required: No

## Response Syntax
<a name="API_GetDocumentTextDetection_ResponseSyntax"></a>

```
{
   "Blocks": [ 
      { 
         "BlockType": "string",
         "ColumnIndex": number,
         "ColumnSpan": number,
         "Confidence": number,
         "EntityTypes": [ "string" ],
         "Geometry": { 
            "BoundingBox": { 
               "Height": number,
               "Left": number,
               "Top": number,
               "Width": number
            },
            "Polygon": [ 
               { 
                  "X": number,
                  "Y": number
               }
            ],
            "RotationAngle": number
         },
         "Id": "string",
         "Page": number,
         "Query": { 
            "Alias": "string",
            "Pages": [ "string" ],
            "Text": "string"
         },
         "Relationships": [ 
            { 
               "Ids": [ "string" ],
               "Type": "string"
            }
         ],
         "RowIndex": number,
         "RowSpan": number,
         "SelectionStatus": "string",
         "Text": "string",
         "TextType": "string"
      }
   ],
   "DetectDocumentTextModelVersion": "string",
   "DocumentMetadata": { 
      "Pages": number
   },
   "JobStatus": "string",
   "NextToken": "string",
   "StatusMessage": "string",
   "Warnings": [ 
      { 
         "ErrorCode": "string",
         "Pages": [ number ]
      }
   ]
}
```

## Response Elements
<a name="API_GetDocumentTextDetection_ResponseElements"></a>

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

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

 ** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-Blocks"></a>
The results of the text-detection operation.  
Type: Array of [Block](API_Block.md) objects

 ** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DetectDocumentTextModelVersion"></a>
  
Type: String

 ** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-DocumentMetadata"></a>
Information about a document that Amazon Textract processed. `DocumentMetadata` is returned in every page of paginated responses from an Amazon Textract video operation.  
Type: [DocumentMetadata](API_DocumentMetadata.md) object

 ** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-JobStatus"></a>
The current status of the text detection job.  
Type: String  
Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-NextToken"></a>
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*` 

 ** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-StatusMessage"></a>
Returns if the detection job could not be completed. Contains explanation for what error occured.   
Type: String

 ** [Warnings](#API_GetDocumentTextDetection_ResponseSyntax) **   <a name="Textract-GetDocumentTextDetection-response-Warnings"></a>
A list of warnings that occurred during the text-detection operation for the document.  
Type: Array of [Warning](API_Warning.md) objects

## Errors
<a name="API_GetDocumentTextDetection_Errors"></a>

 ** 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

 ** InvalidJobIdException **   
An invalid job identifier was passed to an asynchronous analysis operation.  
HTTP Status Code: 400

 ** InvalidKMSKeyException **   
 Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.   
HTTP Status Code: 400

 ** 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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
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

## See Also
<a name="API_GetDocumentTextDetection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentTextDetection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentTextDetection) 

# GetExpenseAnalysis
<a name="API_GetExpenseAnalysis"></a>

Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.

You start asynchronous invoice/receipt analysis by calling [StartExpenseAnalysis](API_StartExpenseAnalysis.md), which returns a job identifier (`JobId`). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to `StartExpenseAnalysis`. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call `GetExpenseAnalysis`, and pass the job identifier (`JobId`) from the initial call to `StartExpenseAnalysis`.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in `MaxResults`, the value of `NextToken` in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call `GetExpenseAnalysis`, and populate the `NextToken` request parameter with the token value that's returned from the previous call to `GetExpenseAnalysis`.

For more information, see [Analyzing Invoices and Receipts](https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html).

## Request Syntax
<a name="API_GetExpenseAnalysis_RequestSyntax"></a>

```
{
   "JobId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_GetExpenseAnalysis_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [JobId](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-JobId"></a>
A unique identifier for the text detection job. The `JobId` is returned from `StartExpenseAnalysis`. A `JobId` value is only valid for 7 days.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$`   
Required: Yes

 ** [MaxResults](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-MaxResults"></a>
The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [NextToken](#API_GetExpenseAnalysis_RequestSyntax) **   <a name="Textract-GetExpenseAnalysis-request-NextToken"></a>
If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*`   
Required: No

## Response Syntax
<a name="API_GetExpenseAnalysis_ResponseSyntax"></a>

```
{
   "AnalyzeExpenseModelVersion": "string",
   "DocumentMetadata": { 
      "Pages": number
   },
   "ExpenseDocuments": [ 
      { 
         "Blocks": [ 
            { 
               "BlockType": "string",
               "ColumnIndex": number,
               "ColumnSpan": number,
               "Confidence": number,
               "EntityTypes": [ "string" ],
               "Geometry": { 
                  "BoundingBox": { 
                     "Height": number,
                     "Left": number,
                     "Top": number,
                     "Width": number
                  },
                  "Polygon": [ 
                     { 
                        "X": number,
                        "Y": number
                     }
                  ],
                  "RotationAngle": number
               },
               "Id": "string",
               "Page": number,
               "Query": { 
                  "Alias": "string",
                  "Pages": [ "string" ],
                  "Text": "string"
               },
               "Relationships": [ 
                  { 
                     "Ids": [ "string" ],
                     "Type": "string"
                  }
               ],
               "RowIndex": number,
               "RowSpan": number,
               "SelectionStatus": "string",
               "Text": "string",
               "TextType": "string"
            }
         ],
         "ExpenseIndex": number,
         "LineItemGroups": [ 
            { 
               "LineItemGroupIndex": number,
               "LineItems": [ 
                  { 
                     "LineItemExpenseFields": [ 
                        { 
                           "Currency": { 
                              "Code": "string",
                              "Confidence": number
                           },
                           "GroupProperties": [ 
                              { 
                                 "Id": "string",
                                 "Types": [ "string" ]
                              }
                           ],
                           "LabelDetection": { 
                              "Confidence": number,
                              "Geometry": { 
                                 "BoundingBox": { 
                                    "Height": number,
                                    "Left": number,
                                    "Top": number,
                                    "Width": number
                                 },
                                 "Polygon": [ 
                                    { 
                                       "X": number,
                                       "Y": number
                                    }
                                 ],
                                 "RotationAngle": number
                              },
                              "Text": "string"
                           },
                           "PageNumber": number,
                           "Type": { 
                              "Confidence": number,
                              "Text": "string"
                           },
                           "ValueDetection": { 
                              "Confidence": number,
                              "Geometry": { 
                                 "BoundingBox": { 
                                    "Height": number,
                                    "Left": number,
                                    "Top": number,
                                    "Width": number
                                 },
                                 "Polygon": [ 
                                    { 
                                       "X": number,
                                       "Y": number
                                    }
                                 ],
                                 "RotationAngle": number
                              },
                              "Text": "string"
                           }
                        }
                     ]
                  }
               ]
            }
         ],
         "SummaryFields": [ 
            { 
               "Currency": { 
                  "Code": "string",
                  "Confidence": number
               },
               "GroupProperties": [ 
                  { 
                     "Id": "string",
                     "Types": [ "string" ]
                  }
               ],
               "LabelDetection": { 
                  "Confidence": number,
                  "Geometry": { 
                     "BoundingBox": { 
                        "Height": number,
                        "Left": number,
                        "Top": number,
                        "Width": number
                     },
                     "Polygon": [ 
                        { 
                           "X": number,
                           "Y": number
                        }
                     ],
                     "RotationAngle": number
                  },
                  "Text": "string"
               },
               "PageNumber": number,
               "Type": { 
                  "Confidence": number,
                  "Text": "string"
               },
               "ValueDetection": { 
                  "Confidence": number,
                  "Geometry": { 
                     "BoundingBox": { 
                        "Height": number,
                        "Left": number,
                        "Top": number,
                        "Width": number
                     },
                     "Polygon": [ 
                        { 
                           "X": number,
                           "Y": number
                        }
                     ],
                     "RotationAngle": number
                  },
                  "Text": "string"
               }
            }
         ]
      }
   ],
   "JobStatus": "string",
   "NextToken": "string",
   "StatusMessage": "string",
   "Warnings": [ 
      { 
         "ErrorCode": "string",
         "Pages": [ number ]
      }
   ]
}
```

## Response Elements
<a name="API_GetExpenseAnalysis_ResponseElements"></a>

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

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

 ** [AnalyzeExpenseModelVersion](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-AnalyzeExpenseModelVersion"></a>
The current model version of AnalyzeExpense.  
Type: String

 ** [DocumentMetadata](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-DocumentMetadata"></a>
Information about a document that Amazon Textract processed. `DocumentMetadata` is returned in every page of paginated responses from an Amazon Textract operation.  
Type: [DocumentMetadata](API_DocumentMetadata.md) object

 ** [ExpenseDocuments](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-ExpenseDocuments"></a>
The expenses detected by Amazon Textract.  
Type: Array of [ExpenseDocument](API_ExpenseDocument.md) objects

 ** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-JobStatus"></a>
The current status of the text detection job.  
Type: String  
Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-NextToken"></a>
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*` 

 ** [StatusMessage](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-StatusMessage"></a>
Returns if the detection job could not be completed. Contains explanation for what error occured.   
Type: String

 ** [Warnings](#API_GetExpenseAnalysis_ResponseSyntax) **   <a name="Textract-GetExpenseAnalysis-response-Warnings"></a>
A list of warnings that occurred during the text-detection operation for the document.  
Type: Array of [Warning](API_Warning.md) objects

## Errors
<a name="API_GetExpenseAnalysis_Errors"></a>

 ** 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

 ** InvalidJobIdException **   
An invalid job identifier was passed to an asynchronous analysis operation.  
HTTP Status Code: 400

 ** InvalidKMSKeyException **   
 Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.   
HTTP Status Code: 400

 ** 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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
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

## See Also
<a name="API_GetExpenseAnalysis_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetExpenseAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetExpenseAnalysis) 

# GetLendingAnalysis
<a name="API_GetLendingAnalysis"></a>

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document. 

You start asynchronous text analysis by calling `StartLendingAnalysis`, which returns a job identifier (`JobId`). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to `StartLendingAnalysis`. 

To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass the job identifier (`JobId`) from the initial call to `StartLendingAnalysis`.

## Request Syntax
<a name="API_GetLendingAnalysis_RequestSyntax"></a>

```
{
   "JobId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_GetLendingAnalysis_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [JobId](#API_GetLendingAnalysis_RequestSyntax) **   <a name="Textract-GetLendingAnalysis-request-JobId"></a>
A unique identifier for the lending or text-detection job. The `JobId` is returned from `StartLendingAnalysis`. A `JobId` value is only valid for 7 days.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$`   
Required: Yes

 ** [MaxResults](#API_GetLendingAnalysis_RequestSyntax) **   <a name="Textract-GetLendingAnalysis-request-MaxResults"></a>
The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [NextToken](#API_GetLendingAnalysis_RequestSyntax) **   <a name="Textract-GetLendingAnalysis-request-NextToken"></a>
If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*`   
Required: No

## Response Syntax
<a name="API_GetLendingAnalysis_ResponseSyntax"></a>

```
{
   "AnalyzeLendingModelVersion": "string",
   "DocumentMetadata": { 
      "Pages": number
   },
   "JobStatus": "string",
   "NextToken": "string",
   "Results": [ 
      { 
         "Extractions": [ 
            { 
               "ExpenseDocument": { 
                  "Blocks": [ 
                     { 
                        "BlockType": "string",
                        "ColumnIndex": number,
                        "ColumnSpan": number,
                        "Confidence": number,
                        "EntityTypes": [ "string" ],
                        "Geometry": { 
                           "BoundingBox": { 
                              "Height": number,
                              "Left": number,
                              "Top": number,
                              "Width": number
                           },
                           "Polygon": [ 
                              { 
                                 "X": number,
                                 "Y": number
                              }
                           ],
                           "RotationAngle": number
                        },
                        "Id": "string",
                        "Page": number,
                        "Query": { 
                           "Alias": "string",
                           "Pages": [ "string" ],
                           "Text": "string"
                        },
                        "Relationships": [ 
                           { 
                              "Ids": [ "string" ],
                              "Type": "string"
                           }
                        ],
                        "RowIndex": number,
                        "RowSpan": number,
                        "SelectionStatus": "string",
                        "Text": "string",
                        "TextType": "string"
                     }
                  ],
                  "ExpenseIndex": number,
                  "LineItemGroups": [ 
                     { 
                        "LineItemGroupIndex": number,
                        "LineItems": [ 
                           { 
                              "LineItemExpenseFields": [ 
                                 { 
                                    "Currency": { 
                                       "Code": "string",
                                       "Confidence": number
                                    },
                                    "GroupProperties": [ 
                                       { 
                                          "Id": "string",
                                          "Types": [ "string" ]
                                       }
                                    ],
                                    "LabelDetection": { 
                                       "Confidence": number,
                                       "Geometry": { 
                                          "BoundingBox": { 
                                             "Height": number,
                                             "Left": number,
                                             "Top": number,
                                             "Width": number
                                          },
                                          "Polygon": [ 
                                             { 
                                                "X": number,
                                                "Y": number
                                             }
                                          ],
                                          "RotationAngle": number
                                       },
                                       "Text": "string"
                                    },
                                    "PageNumber": number,
                                    "Type": { 
                                       "Confidence": number,
                                       "Text": "string"
                                    },
                                    "ValueDetection": { 
                                       "Confidence": number,
                                       "Geometry": { 
                                          "BoundingBox": { 
                                             "Height": number,
                                             "Left": number,
                                             "Top": number,
                                             "Width": number
                                          },
                                          "Polygon": [ 
                                             { 
                                                "X": number,
                                                "Y": number
                                             }
                                          ],
                                          "RotationAngle": number
                                       },
                                       "Text": "string"
                                    }
                                 }
                              ]
                           }
                        ]
                     }
                  ],
                  "SummaryFields": [ 
                     { 
                        "Currency": { 
                           "Code": "string",
                           "Confidence": number
                        },
                        "GroupProperties": [ 
                           { 
                              "Id": "string",
                              "Types": [ "string" ]
                           }
                        ],
                        "LabelDetection": { 
                           "Confidence": number,
                           "Geometry": { 
                              "BoundingBox": { 
                                 "Height": number,
                                 "Left": number,
                                 "Top": number,
                                 "Width": number
                              },
                              "Polygon": [ 
                                 { 
                                    "X": number,
                                    "Y": number
                                 }
                              ],
                              "RotationAngle": number
                           },
                           "Text": "string"
                        },
                        "PageNumber": number,
                        "Type": { 
                           "Confidence": number,
                           "Text": "string"
                        },
                        "ValueDetection": { 
                           "Confidence": number,
                           "Geometry": { 
                              "BoundingBox": { 
                                 "Height": number,
                                 "Left": number,
                                 "Top": number,
                                 "Width": number
                              },
                              "Polygon": [ 
                                 { 
                                    "X": number,
                                    "Y": number
                                 }
                              ],
                              "RotationAngle": number
                           },
                           "Text": "string"
                        }
                     }
                  ]
               },
               "IdentityDocument": { 
                  "Blocks": [ 
                     { 
                        "BlockType": "string",
                        "ColumnIndex": number,
                        "ColumnSpan": number,
                        "Confidence": number,
                        "EntityTypes": [ "string" ],
                        "Geometry": { 
                           "BoundingBox": { 
                              "Height": number,
                              "Left": number,
                              "Top": number,
                              "Width": number
                           },
                           "Polygon": [ 
                              { 
                                 "X": number,
                                 "Y": number
                              }
                           ],
                           "RotationAngle": number
                        },
                        "Id": "string",
                        "Page": number,
                        "Query": { 
                           "Alias": "string",
                           "Pages": [ "string" ],
                           "Text": "string"
                        },
                        "Relationships": [ 
                           { 
                              "Ids": [ "string" ],
                              "Type": "string"
                           }
                        ],
                        "RowIndex": number,
                        "RowSpan": number,
                        "SelectionStatus": "string",
                        "Text": "string",
                        "TextType": "string"
                     }
                  ],
                  "DocumentIndex": number,
                  "IdentityDocumentFields": [ 
                     { 
                        "Type": { 
                           "Confidence": number,
                           "NormalizedValue": { 
                              "Value": "string",
                              "ValueType": "string"
                           },
                           "Text": "string"
                        },
                        "ValueDetection": { 
                           "Confidence": number,
                           "NormalizedValue": { 
                              "Value": "string",
                              "ValueType": "string"
                           },
                           "Text": "string"
                        }
                     }
                  ]
               },
               "LendingDocument": { 
                  "LendingFields": [ 
                     { 
                        "KeyDetection": { 
                           "Confidence": number,
                           "Geometry": { 
                              "BoundingBox": { 
                                 "Height": number,
                                 "Left": number,
                                 "Top": number,
                                 "Width": number
                              },
                              "Polygon": [ 
                                 { 
                                    "X": number,
                                    "Y": number
                                 }
                              ],
                              "RotationAngle": number
                           },
                           "SelectionStatus": "string",
                           "Text": "string"
                        },
                        "Type": "string",
                        "ValueDetections": [ 
                           { 
                              "Confidence": number,
                              "Geometry": { 
                                 "BoundingBox": { 
                                    "Height": number,
                                    "Left": number,
                                    "Top": number,
                                    "Width": number
                                 },
                                 "Polygon": [ 
                                    { 
                                       "X": number,
                                       "Y": number
                                    }
                                 ],
                                 "RotationAngle": number
                              },
                              "SelectionStatus": "string",
                              "Text": "string"
                           }
                        ]
                     }
                  ],
                  "SignatureDetections": [ 
                     { 
                        "Confidence": number,
                        "Geometry": { 
                           "BoundingBox": { 
                              "Height": number,
                              "Left": number,
                              "Top": number,
                              "Width": number
                           },
                           "Polygon": [ 
                              { 
                                 "X": number,
                                 "Y": number
                              }
                           ],
                           "RotationAngle": number
                        }
                     }
                  ]
               }
            }
         ],
         "Page": number,
         "PageClassification": { 
            "PageNumber": [ 
               { 
                  "Confidence": number,
                  "Value": "string"
               }
            ],
            "PageType": [ 
               { 
                  "Confidence": number,
                  "Value": "string"
               }
            ]
         }
      }
   ],
   "StatusMessage": "string",
   "Warnings": [ 
      { 
         "ErrorCode": "string",
         "Pages": [ number ]
      }
   ]
}
```

## Response Elements
<a name="API_GetLendingAnalysis_ResponseElements"></a>

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

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

 ** [AnalyzeLendingModelVersion](#API_GetLendingAnalysis_ResponseSyntax) **   <a name="Textract-GetLendingAnalysis-response-AnalyzeLendingModelVersion"></a>
 The current model version of the Analyze Lending API.  
Type: String

 ** [DocumentMetadata](#API_GetLendingAnalysis_ResponseSyntax) **   <a name="Textract-GetLendingAnalysis-response-DocumentMetadata"></a>
Information about the input document.  
Type: [DocumentMetadata](API_DocumentMetadata.md) object

 ** [JobStatus](#API_GetLendingAnalysis_ResponseSyntax) **   <a name="Textract-GetLendingAnalysis-response-JobStatus"></a>
 The current status of the lending analysis job.  
Type: String  
Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [NextToken](#API_GetLendingAnalysis_ResponseSyntax) **   <a name="Textract-GetLendingAnalysis-response-NextToken"></a>
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of lending results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*` 

 ** [Results](#API_GetLendingAnalysis_ResponseSyntax) **   <a name="Textract-GetLendingAnalysis-response-Results"></a>
 Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.  
Type: Array of [LendingResult](API_LendingResult.md) objects

 ** [StatusMessage](#API_GetLendingAnalysis_ResponseSyntax) **   <a name="Textract-GetLendingAnalysis-response-StatusMessage"></a>
 Returns if the lending analysis job could not be completed. Contains explanation for what error occurred.   
Type: String

 ** [Warnings](#API_GetLendingAnalysis_ResponseSyntax) **   <a name="Textract-GetLendingAnalysis-response-Warnings"></a>
 A list of warnings that occurred during the lending analysis operation.   
Type: Array of [Warning](API_Warning.md) objects

## Errors
<a name="API_GetLendingAnalysis_Errors"></a>

 ** 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

 ** InvalidJobIdException **   
An invalid job identifier was passed to an asynchronous analysis operation.  
HTTP Status Code: 400

 ** InvalidKMSKeyException **   
 Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.   
HTTP Status Code: 400

 ** 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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
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

## See Also
<a name="API_GetLendingAnalysis_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetLendingAnalysis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetLendingAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetLendingAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetLendingAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetLendingAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetLendingAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetLendingAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetLendingAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetLendingAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetLendingAnalysis) 

# GetLendingAnalysisSummary
<a name="API_GetLendingAnalysisSummary"></a>

Gets summarized results for the `StartLendingAnalysis` operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document. 

You start asynchronous text analysis by calling `StartLendingAnalysis`, which returns a job identifier (`JobId`). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to `StartLendingAnalysis`. 

To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call `GetLendingAnalysisSummary`, and pass the job identifier (`JobId`) from the initial call to `StartLendingAnalysis`.

## Request Syntax
<a name="API_GetLendingAnalysisSummary_RequestSyntax"></a>

```
{
   "JobId": "string"
}
```

## Request Parameters
<a name="API_GetLendingAnalysisSummary_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [JobId](#API_GetLendingAnalysisSummary_RequestSyntax) **   <a name="Textract-GetLendingAnalysisSummary-request-JobId"></a>
 A unique identifier for the lending or text-detection job. The `JobId` is returned from StartLendingAnalysis. A `JobId` value is only valid for 7 days.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$`   
Required: Yes

## Response Syntax
<a name="API_GetLendingAnalysisSummary_ResponseSyntax"></a>

```
{
   "AnalyzeLendingModelVersion": "string",
   "DocumentMetadata": { 
      "Pages": number
   },
   "JobStatus": "string",
   "StatusMessage": "string",
   "Summary": { 
      "DocumentGroups": [ 
         { 
            "DetectedSignatures": [ 
               { 
                  "Page": number
               }
            ],
            "SplitDocuments": [ 
               { 
                  "Index": number,
                  "Pages": [ number ]
               }
            ],
            "Type": "string",
            "UndetectedSignatures": [ 
               { 
                  "Page": number
               }
            ]
         }
      ],
      "UndetectedDocumentTypes": [ "string" ]
   },
   "Warnings": [ 
      { 
         "ErrorCode": "string",
         "Pages": [ number ]
      }
   ]
}
```

## Response Elements
<a name="API_GetLendingAnalysisSummary_ResponseElements"></a>

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

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

 ** [AnalyzeLendingModelVersion](#API_GetLendingAnalysisSummary_ResponseSyntax) **   <a name="Textract-GetLendingAnalysisSummary-response-AnalyzeLendingModelVersion"></a>
The current model version of the Analyze Lending API.  
Type: String

 ** [DocumentMetadata](#API_GetLendingAnalysisSummary_ResponseSyntax) **   <a name="Textract-GetLendingAnalysisSummary-response-DocumentMetadata"></a>
Information about the input document.  
Type: [DocumentMetadata](API_DocumentMetadata.md) object

 ** [JobStatus](#API_GetLendingAnalysisSummary_ResponseSyntax) **   <a name="Textract-GetLendingAnalysisSummary-response-JobStatus"></a>
 The current status of the lending analysis job.   
Type: String  
Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` 

 ** [StatusMessage](#API_GetLendingAnalysisSummary_ResponseSyntax) **   <a name="Textract-GetLendingAnalysisSummary-response-StatusMessage"></a>
Returns if the lending analysis could not be completed. Contains explanation for what error occurred.  
Type: String

 ** [Summary](#API_GetLendingAnalysisSummary_ResponseSyntax) **   <a name="Textract-GetLendingAnalysisSummary-response-Summary"></a>
 Contains summary information for documents grouped by type.  
Type: [LendingSummary](API_LendingSummary.md) object

 ** [Warnings](#API_GetLendingAnalysisSummary_ResponseSyntax) **   <a name="Textract-GetLendingAnalysisSummary-response-Warnings"></a>
A list of warnings that occurred during the lending analysis operation.  
Type: Array of [Warning](API_Warning.md) objects

## Errors
<a name="API_GetLendingAnalysisSummary_Errors"></a>

 ** 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

 ** InvalidJobIdException **   
An invalid job identifier was passed to an asynchronous analysis operation.  
HTTP Status Code: 400

 ** InvalidKMSKeyException **   
 Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.   
HTTP Status Code: 400

 ** 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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
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

## See Also
<a name="API_GetLendingAnalysisSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetLendingAnalysisSummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetLendingAnalysisSummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetLendingAnalysisSummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetLendingAnalysisSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetLendingAnalysisSummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetLendingAnalysisSummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetLendingAnalysisSummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetLendingAnalysisSummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetLendingAnalysisSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetLendingAnalysisSummary) 

# ListAdapters
<a name="API_ListAdapters"></a>

Lists all adapters that match the specified filtration criteria.

## Request Syntax
<a name="API_ListAdapters_RequestSyntax"></a>

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

## Request Parameters
<a name="API_ListAdapters_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AfterCreationTime](#API_ListAdapters_RequestSyntax) **   <a name="Textract-ListAdapters-request-AfterCreationTime"></a>
Specifies the lower bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created after the specified creation time.  
Type: Timestamp  
Required: No

 ** [BeforeCreationTime](#API_ListAdapters_RequestSyntax) **   <a name="Textract-ListAdapters-request-BeforeCreationTime"></a>
Specifies the upper bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created before the specified creation time.  
Type: Timestamp  
Required: No

 ** [MaxResults](#API_ListAdapters_RequestSyntax) **   <a name="Textract-ListAdapters-request-MaxResults"></a>
The maximum number of results to return when listing adapters.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [NextToken](#API_ListAdapters_RequestSyntax) **   <a name="Textract-ListAdapters-request-NextToken"></a>
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
<a name="API_ListAdapters_ResponseSyntax"></a>

```
{
   "Adapters": [ 
      { 
         "AdapterId": "string",
         "AdapterName": "string",
         "CreationTime": number,
         "FeatureTypes": [ "string" ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAdapters_ResponseElements"></a>

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](#API_ListAdapters_ResponseSyntax) **   <a name="Textract-ListAdapters-response-Adapters"></a>
A list of adapters that matches the filtering criteria specified when calling ListAdapters.  
Type: Array of [AdapterOverview](API_AdapterOverview.md) objects

 ** [NextToken](#API_ListAdapters_ResponseSyntax) **   <a name="Textract-ListAdapters-response-NextToken"></a>
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
<a name="API_ListAdapters_Errors"></a>

 ** 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

## See Also
<a name="API_ListAdapters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/ListAdapters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/ListAdapters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ListAdapters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/ListAdapters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ListAdapters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/ListAdapters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/ListAdapters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/ListAdapters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/ListAdapters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ListAdapters) 

# ListAdapterVersions
<a name="API_ListAdapterVersions"></a>

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

## Request Syntax
<a name="API_ListAdapterVersions_RequestSyntax"></a>

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

## Request Parameters
<a name="API_ListAdapterVersions_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AdapterId](#API_ListAdapterVersions_RequestSyntax) **   <a name="Textract-ListAdapterVersions-request-AdapterId"></a>
A string containing a unique ID for the adapter to match for when listing adapter versions.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.  
Required: No

 ** [AfterCreationTime](#API_ListAdapterVersions_RequestSyntax) **   <a name="Textract-ListAdapterVersions-request-AfterCreationTime"></a>
Specifies the lower bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.  
Type: Timestamp  
Required: No

 ** [BeforeCreationTime](#API_ListAdapterVersions_RequestSyntax) **   <a name="Textract-ListAdapterVersions-request-BeforeCreationTime"></a>
Specifies the upper bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.  
Type: Timestamp  
Required: No

 ** [MaxResults](#API_ListAdapterVersions_RequestSyntax) **   <a name="Textract-ListAdapterVersions-request-MaxResults"></a>
The maximum number of results to return when listing adapter versions.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [NextToken](#API_ListAdapterVersions_RequestSyntax) **   <a name="Textract-ListAdapterVersions-request-NextToken"></a>
Identifies the next page of results to return when listing adapter versions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*`   
Required: No

## Response Syntax
<a name="API_ListAdapterVersions_ResponseSyntax"></a>

```
{
   "AdapterVersions": [ 
      { 
         "AdapterId": "string",
         "AdapterVersion": "string",
         "CreationTime": number,
         "FeatureTypes": [ "string" ],
         "Status": "string",
         "StatusMessage": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAdapterVersions_ResponseElements"></a>

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

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

 ** [AdapterVersions](#API_ListAdapterVersions_ResponseSyntax) **   <a name="Textract-ListAdapterVersions-response-AdapterVersions"></a>
Adapter versions that match the filtering criteria specified when calling ListAdapters.  
Type: Array of [AdapterVersionOverview](API_AdapterVersionOverview.md) objects

 ** [NextToken](#API_ListAdapterVersions_ResponseSyntax) **   <a name="Textract-ListAdapterVersions-response-NextToken"></a>
Identifies the next page of results to return when listing adapter versions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*` 

## Errors
<a name="API_ListAdapterVersions_Errors"></a>

 ** 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

 ** 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

## See Also
<a name="API_ListAdapterVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/ListAdapterVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/ListAdapterVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ListAdapterVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/ListAdapterVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ListAdapterVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/ListAdapterVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/ListAdapterVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/ListAdapterVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/ListAdapterVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ListAdapterVersions) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lists all tags for an Amazon Textract resource.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **   <a name="Textract-ListTagsForResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) that specifies the resource to list tags for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

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

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

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="Textract-ListTagsForResource-response-Tags"></a>
A set of tags (key-value pairs) that are part of the requested resource.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 

## Errors
<a name="API_ListTagsForResource_Errors"></a>

 ** 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

 ** 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

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ListTagsForResource) 

# StartDocumentAnalysis
<a name="API_StartDocumentAnalysis"></a>

Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.

 `StartDocumentAnalysis` can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use [DocumentLocation](API_DocumentLocation.md) to specify the bucket name and file name of the document. 

 `StartDocumentAnalysis` returns a job identifier (`JobId`) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in `NotificationChannel`. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call [GetDocumentAnalysis](API_GetDocumentAnalysis.md), and pass the job identifier (`JobId`) from the initial call to `StartDocumentAnalysis`.

For more information, see [Document Text Analysis](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html).

## Request Syntax
<a name="API_StartDocumentAnalysis_RequestSyntax"></a>

```
{
   "AdaptersConfig": { 
      "Adapters": [ 
         { 
            "AdapterId": "string",
            "Pages": [ "string" ],
            "Version": "string"
         }
      ]
   },
   "ClientRequestToken": "string",
   "DocumentLocation": { 
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "FeatureTypes": [ "string" ],
   "JobTag": "string",
   "KMSKeyId": "string",
   "NotificationChannel": { 
      "RoleArn": "string",
      "SNSTopicArn": "string"
   },
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   },
   "QueriesConfig": { 
      "Queries": [ 
         { 
            "Alias": "string",
            "Pages": [ "string" ],
            "Text": "string"
         }
      ]
   }
}
```

## Request Parameters
<a name="API_StartDocumentAnalysis_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AdaptersConfig](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-AdaptersConfig"></a>
Specifies the adapter to be used when analyzing a document.  
Type: [AdaptersConfig](API_AdaptersConfig.md) object  
Required: No

 ** [ClientRequestToken](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-ClientRequestToken"></a>
The idempotent token that you use to identify the start request. If you use the same token with multiple `StartDocumentAnalysis` requests, the same `JobId` is returned. Use `ClientRequestToken` to prevent the same job from being accidentally started more than once. For more information, see [Calling Amazon Textract Asynchronous Operations](https://docs.aws.amazon.com/textract/latest/dg/api-async.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$`   
Required: No

 ** [DocumentLocation](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-DocumentLocation"></a>
The location of the document to be processed.  
Type: [DocumentLocation](API_DocumentLocation.md) object  
Required: Yes

 ** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-FeatureTypes"></a>
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to `FeatureTypes`. All lines and words detected in the document are included in the response (including text that isn't related to the value of `FeatureTypes`).   
Type: Array of strings  
Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT`   
Required: Yes

 ** [JobTag](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-JobTag"></a>
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use `JobTag` to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_.\-:]+`   
Required: No

 ** [KMSKeyId](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-KMSKeyId"></a>
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
Required: No

 ** [NotificationChannel](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-NotificationChannel"></a>
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.   
Type: [NotificationChannel](API_NotificationChannel.md) object  
Required: No

 ** [OutputConfig](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-OutputConfig"></a>
Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.  
Type: [OutputConfig](API_OutputConfig.md) object  
Required: No

 ** [QueriesConfig](#API_StartDocumentAnalysis_RequestSyntax) **   <a name="Textract-StartDocumentAnalysis-request-QueriesConfig"></a>
  
Type: [QueriesConfig](API_QueriesConfig.md) object  
Required: No

## Response Syntax
<a name="API_StartDocumentAnalysis_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## Response Elements
<a name="API_StartDocumentAnalysis_ResponseElements"></a>

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

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

 ** [JobId](#API_StartDocumentAnalysis_ResponseSyntax) **   <a name="Textract-StartDocumentAnalysis-response-JobId"></a>
The identifier for the document text detection job. Use `JobId` to identify the job in a subsequent call to `GetDocumentAnalysis`. A `JobId` value is only valid for 7 days.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$` 

## Errors
<a name="API_StartDocumentAnalysis_Errors"></a>

 ** 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

 ** BadDocumentException **   
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md).  
HTTP Status Code: 400

 ** DocumentTooLargeException **   
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.  
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
A `ClientRequestToken` input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.   
HTTP Status Code: 400

 ** InternalServerError **   
Amazon Textract experienced a service issue. Try your call again.  
HTTP Status Code: 500

 ** InvalidKMSKeyException **   
 Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.   
HTTP Status Code: 400

 ** 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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
HTTP Status Code: 400

 ** LimitExceededException **   
An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (`StartDocumentTextDetection`, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.   
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

 ** UnsupportedDocumentException **   
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.  
HTTP Status Code: 400

## See Also
<a name="API_StartDocumentAnalysis_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentAnalysis) 

# StartDocumentTextDetection
<a name="API_StartDocumentTextDetection"></a>

Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

 `StartDocumentTextDetection` can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use [DocumentLocation](API_DocumentLocation.md) to specify the bucket name and file name of the document. 

 `StartDocumentTextDetection` returns a job identifier (`JobId`) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in `NotificationChannel`. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call [GetDocumentTextDetection](API_GetDocumentTextDetection.md), and pass the job identifier (`JobId`) from the initial call to `StartDocumentTextDetection`.

For more information, see [Document Text Detection](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html).

## Request Syntax
<a name="API_StartDocumentTextDetection_RequestSyntax"></a>

```
{
   "ClientRequestToken": "string",
   "DocumentLocation": { 
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "JobTag": "string",
   "KMSKeyId": "string",
   "NotificationChannel": { 
      "RoleArn": "string",
      "SNSTopicArn": "string"
   },
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   }
}
```

## Request Parameters
<a name="API_StartDocumentTextDetection_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientRequestToken](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-ClientRequestToken"></a>
The idempotent token that's used to identify the start request. If you use the same token with multiple `StartDocumentTextDetection` requests, the same `JobId` is returned. Use `ClientRequestToken` to prevent the same job from being accidentally started more than once. For more information, see [Calling Amazon Textract Asynchronous Operations](https://docs.aws.amazon.com/textract/latest/dg/api-async.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$`   
Required: No

 ** [DocumentLocation](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-DocumentLocation"></a>
The location of the document to be processed.  
Type: [DocumentLocation](API_DocumentLocation.md) object  
Required: Yes

 ** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-JobTag"></a>
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use `JobTag` to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_.\-:]+`   
Required: No

 ** [KMSKeyId](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-KMSKeyId"></a>
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
Required: No

 ** [NotificationChannel](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-NotificationChannel"></a>
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.   
Type: [NotificationChannel](API_NotificationChannel.md) object  
Required: No

 ** [OutputConfig](#API_StartDocumentTextDetection_RequestSyntax) **   <a name="Textract-StartDocumentTextDetection-request-OutputConfig"></a>
Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.  
Type: [OutputConfig](API_OutputConfig.md) object  
Required: No

## Response Syntax
<a name="API_StartDocumentTextDetection_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## Response Elements
<a name="API_StartDocumentTextDetection_ResponseElements"></a>

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

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

 ** [JobId](#API_StartDocumentTextDetection_ResponseSyntax) **   <a name="Textract-StartDocumentTextDetection-response-JobId"></a>
The identifier of the text detection job for the document. Use `JobId` to identify the job in a subsequent call to `GetDocumentTextDetection`. A `JobId` value is only valid for 7 days.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$` 

## Errors
<a name="API_StartDocumentTextDetection_Errors"></a>

 ** 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

 ** BadDocumentException **   
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md).  
HTTP Status Code: 400

 ** DocumentTooLargeException **   
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.  
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
A `ClientRequestToken` input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.   
HTTP Status Code: 400

 ** InternalServerError **   
Amazon Textract experienced a service issue. Try your call again.  
HTTP Status Code: 500

 ** InvalidKMSKeyException **   
 Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.   
HTTP Status Code: 400

 ** 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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
HTTP Status Code: 400

 ** LimitExceededException **   
An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (`StartDocumentTextDetection`, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.   
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

 ** UnsupportedDocumentException **   
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.  
HTTP Status Code: 400

## See Also
<a name="API_StartDocumentTextDetection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentTextDetection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentTextDetection) 

# StartExpenseAnalysis
<a name="API_StartExpenseAnalysis"></a>

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

 `StartExpenseAnalysis` can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the [DocumentLocation](API_DocumentLocation.md) parameter to specify the name of your S3 bucket and the name of the document in that bucket. 

 `StartExpenseAnalysis` returns a job identifier (`JobId`) that you will provide to `GetExpenseAnalysis` to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the `NotificationChannel`. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call [GetExpenseAnalysis](API_GetExpenseAnalysis.md), and pass the job identifier (`JobId`) that was returned by your call to `StartExpenseAnalysis`.

For more information, see [Analyzing Invoices and Receipts](https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html).

## Request Syntax
<a name="API_StartExpenseAnalysis_RequestSyntax"></a>

```
{
   "ClientRequestToken": "string",
   "DocumentLocation": { 
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "JobTag": "string",
   "KMSKeyId": "string",
   "NotificationChannel": { 
      "RoleArn": "string",
      "SNSTopicArn": "string"
   },
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   }
}
```

## Request Parameters
<a name="API_StartExpenseAnalysis_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientRequestToken](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-ClientRequestToken"></a>
The idempotent token that's used to identify the start request. If you use the same token with multiple `StartDocumentTextDetection` requests, the same `JobId` is returned. Use `ClientRequestToken` to prevent the same job from being accidentally started more than once. For more information, see [Calling Amazon Textract Asynchronous Operations](https://docs.aws.amazon.com/textract/latest/dg/api-async.html)   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$`   
Required: No

 ** [DocumentLocation](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-DocumentLocation"></a>
The location of the document to be processed.  
Type: [DocumentLocation](API_DocumentLocation.md) object  
Required: Yes

 ** [JobTag](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-JobTag"></a>
An identifier you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use `JobTag` to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_.\-:]+`   
Required: No

 ** [KMSKeyId](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-KMSKeyId"></a>
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
Required: No

 ** [NotificationChannel](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-NotificationChannel"></a>
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.   
Type: [NotificationChannel](API_NotificationChannel.md) object  
Required: No

 ** [OutputConfig](#API_StartExpenseAnalysis_RequestSyntax) **   <a name="Textract-StartExpenseAnalysis-request-OutputConfig"></a>
Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the `GetExpenseAnalysis` operation.  
Type: [OutputConfig](API_OutputConfig.md) object  
Required: No

## Response Syntax
<a name="API_StartExpenseAnalysis_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## Response Elements
<a name="API_StartExpenseAnalysis_ResponseElements"></a>

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

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

 ** [JobId](#API_StartExpenseAnalysis_ResponseSyntax) **   <a name="Textract-StartExpenseAnalysis-response-JobId"></a>
A unique identifier for the text detection job. The `JobId` is returned from `StartExpenseAnalysis`. A `JobId` value is only valid for 7 days.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$` 

## Errors
<a name="API_StartExpenseAnalysis_Errors"></a>

 ** 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

 ** BadDocumentException **   
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md).  
HTTP Status Code: 400

 ** DocumentTooLargeException **   
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.  
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
A `ClientRequestToken` input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.   
HTTP Status Code: 400

 ** InternalServerError **   
Amazon Textract experienced a service issue. Try your call again.  
HTTP Status Code: 500

 ** InvalidKMSKeyException **   
 Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.   
HTTP Status Code: 400

 ** 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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
HTTP Status Code: 400

 ** LimitExceededException **   
An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (`StartDocumentTextDetection`, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.   
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

 ** UnsupportedDocumentException **   
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.  
HTTP Status Code: 400

## See Also
<a name="API_StartExpenseAnalysis_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartExpenseAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartExpenseAnalysis) 

# StartLendingAnalysis
<a name="API_StartLendingAnalysis"></a>

Starts the classification and analysis of an input document. `StartLendingAnalysis` initiates the classification and analysis of a packet of lending documents. `StartLendingAnalysis` operates on a document file located in an Amazon S3 bucket.

 `StartLendingAnalysis` can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use `DocumentLocation` to specify the bucket name and the file name of the document. 

 `StartLendingAnalysis` returns a job identifier (`JobId`) that you use to get the results of the operation. When the text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in `NotificationChannel`. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either `GetLendingAnalysis` or `GetLendingAnalysisSummary` and provide the `JobId` to obtain the results of the analysis.

If using `OutputConfig` to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories: 
+ detailedResponse (contains the GetLendingAnalysis response)
+ summaryResponse (for the GetLendingAnalysisSummary response)
+ splitDocuments (documents split across logical boundaries)

## Request Syntax
<a name="API_StartLendingAnalysis_RequestSyntax"></a>

```
{
   "ClientRequestToken": "string",
   "DocumentLocation": { 
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "JobTag": "string",
   "KMSKeyId": "string",
   "NotificationChannel": { 
      "RoleArn": "string",
      "SNSTopicArn": "string"
   },
   "OutputConfig": { 
      "S3Bucket": "string",
      "S3Prefix": "string"
   }
}
```

## Request Parameters
<a name="API_StartLendingAnalysis_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientRequestToken](#API_StartLendingAnalysis_RequestSyntax) **   <a name="Textract-StartLendingAnalysis-request-ClientRequestToken"></a>
The idempotent token that you use to identify the start request. If you use the same token with multiple `StartLendingAnalysis` requests, the same `JobId` is returned. Use `ClientRequestToken` to prevent the same job from being accidentally started more than once. For more information, see [Calling Amazon Textract Asynchronous Operations](https://docs.aws.amazon.com/textract/latest/dg/api-sync.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$`   
Required: No

 ** [DocumentLocation](#API_StartLendingAnalysis_RequestSyntax) **   <a name="Textract-StartLendingAnalysis-request-DocumentLocation"></a>
The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations.  
The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.  
Type: [DocumentLocation](API_DocumentLocation.md) object  
Required: Yes

 ** [JobTag](#API_StartLendingAnalysis_RequestSyntax) **   <a name="Textract-StartLendingAnalysis-request-JobTag"></a>
An identifier that you specify to be included in the completion notification published to the Amazon SNS topic. For example, you can use `JobTag` to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_.\-:]+`   
Required: No

 ** [KMSKeyId](#API_StartLendingAnalysis_RequestSyntax) **   <a name="Textract-StartLendingAnalysis-request-KMSKeyId"></a>
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side, using SSE-S3.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
Required: No

 ** [NotificationChannel](#API_StartLendingAnalysis_RequestSyntax) **   <a name="Textract-StartLendingAnalysis-request-NotificationChannel"></a>
The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.   
Type: [NotificationChannel](API_NotificationChannel.md) object  
Required: No

 ** [OutputConfig](#API_StartLendingAnalysis_RequestSyntax) **   <a name="Textract-StartLendingAnalysis-request-OutputConfig"></a>
Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.  
 `OutputConfig` is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With `OutputConfig` enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the `KMSKeyID` parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.  
Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see [ Managing AI services opt-out policy. ](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html)   
For more information on data privacy, see the [Data Privacy FAQ](https://aws.amazon.com/compliance/data-privacy-faq/).  
Type: [OutputConfig](API_OutputConfig.md) object  
Required: No

## Response Syntax
<a name="API_StartLendingAnalysis_ResponseSyntax"></a>

```
{
   "JobId": "string"
}
```

## Response Elements
<a name="API_StartLendingAnalysis_ResponseElements"></a>

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

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

 ** [JobId](#API_StartLendingAnalysis_ResponseSyntax) **   <a name="Textract-StartLendingAnalysis-response-JobId"></a>
A unique identifier for the lending or text-detection job. The `JobId` is returned from `StartLendingAnalysis`. A `JobId` value is only valid for 7 days.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$` 

## Errors
<a name="API_StartLendingAnalysis_Errors"></a>

 ** 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

 ** BadDocumentException **   
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md).  
HTTP Status Code: 400

 ** DocumentTooLargeException **   
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.  
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
A `ClientRequestToken` input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.   
HTTP Status Code: 400

 ** InternalServerError **   
Amazon Textract experienced a service issue. Try your call again.  
HTTP Status Code: 500

 ** InvalidKMSKeyException **   
 Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.   
HTTP Status Code: 400

 ** 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

 ** InvalidS3ObjectException **   
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html)   
HTTP Status Code: 400

 ** LimitExceededException **   
An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (`StartDocumentTextDetection`, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.   
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

 ** UnsupportedDocumentException **   
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.  
HTTP Status Code: 400

## See Also
<a name="API_StartLendingAnalysis_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/StartLendingAnalysis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/StartLendingAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartLendingAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/StartLendingAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartLendingAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/StartLendingAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/StartLendingAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartLendingAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartLendingAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartLendingAnalysis) 

# TagResource
<a name="API_TagResource"></a>

Adds one or more tags to the specified resource.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_TagResource_RequestSyntax) **   <a name="Textract-TagResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) that specifies the resource to be tagged.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="Textract-TagResource-request-Tags"></a>
A set of tags (key-value pairs) that you want to assign to the resource.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

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

## Errors
<a name="API_TagResource_Errors"></a>

 ** 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

 ** ResourceNotFoundException **   
 Returned when an operation tried to access a nonexistent resource.   
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
Returned when a request cannot be completed as it would exceed a maximum service quota.  
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

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Removes any tags with the specified keys from the specified resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_UntagResource_RequestSyntax) **   <a name="Textract-UntagResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) that specifies the resource to be untagged.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="Textract-UntagResource-request-TagKeys"></a>
Specifies the tags to be removed from the resource specified by the ResourceARN.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Required: Yes

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

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

## Errors
<a name="API_UntagResource_Errors"></a>

 ** 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

 ** 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

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/UntagResource) 

# UpdateAdapter
<a name="API_UpdateAdapter"></a>

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

## Request Syntax
<a name="API_UpdateAdapter_RequestSyntax"></a>

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

## Request Parameters
<a name="API_UpdateAdapter_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AdapterId](#API_UpdateAdapter_RequestSyntax) **   <a name="Textract-UpdateAdapter-request-AdapterId"></a>
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](#API_UpdateAdapter_RequestSyntax) **   <a name="Textract-UpdateAdapter-request-AdapterName"></a>
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](#API_UpdateAdapter_RequestSyntax) **   <a name="Textract-UpdateAdapter-request-AutoUpdate"></a>
The new auto-update status to be applied to the adapter.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [Description](#API_UpdateAdapter_RequestSyntax) **   <a name="Textract-UpdateAdapter-request-Description"></a>
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
<a name="API_UpdateAdapter_ResponseSyntax"></a>

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

## Response Elements
<a name="API_UpdateAdapter_ResponseElements"></a>

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](#API_UpdateAdapter_ResponseSyntax) **   <a name="Textract-UpdateAdapter-response-AdapterId"></a>
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](#API_UpdateAdapter_ResponseSyntax) **   <a name="Textract-UpdateAdapter-response-AdapterName"></a>
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](#API_UpdateAdapter_ResponseSyntax) **   <a name="Textract-UpdateAdapter-response-AutoUpdate"></a>
The auto-update status of the adapter that has been updated.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [CreationTime](#API_UpdateAdapter_ResponseSyntax) **   <a name="Textract-UpdateAdapter-response-CreationTime"></a>
An object specifying the creation time of the the adapter that has been updated.  
Type: Timestamp

 ** [Description](#API_UpdateAdapter_ResponseSyntax) **   <a name="Textract-UpdateAdapter-response-Description"></a>
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](#API_UpdateAdapter_ResponseSyntax) **   <a name="Textract-UpdateAdapter-response-FeatureTypes"></a>
List of the targeted feature types for the updated adapter.  
Type: Array of strings  
Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT` 

## Errors
<a name="API_UpdateAdapter_Errors"></a>

 ** 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

## See Also
<a name="API_UpdateAdapter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/UpdateAdapter) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/UpdateAdapter) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/UpdateAdapter) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/UpdateAdapter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/UpdateAdapter) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/UpdateAdapter) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/UpdateAdapter) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/UpdateAdapter) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/UpdateAdapter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/UpdateAdapter) 

# Data Types
<a name="API_Types"></a>

The following data types are supported:
+  [Adapter](API_Adapter.md) 
+  [AdapterOverview](API_AdapterOverview.md) 
+  [AdaptersConfig](API_AdaptersConfig.md) 
+  [AdapterVersionDatasetConfig](API_AdapterVersionDatasetConfig.md) 
+  [AdapterVersionEvaluationMetric](API_AdapterVersionEvaluationMetric.md) 
+  [AdapterVersionOverview](API_AdapterVersionOverview.md) 
+  [AnalyzeIDDetections](API_AnalyzeIDDetections.md) 
+  [Block](API_Block.md) 
+  [BoundingBox](API_BoundingBox.md) 
+  [DetectedSignature](API_DetectedSignature.md) 
+  [Document](API_Document.md) 
+  [DocumentGroup](API_DocumentGroup.md) 
+  [DocumentLocation](API_DocumentLocation.md) 
+  [DocumentMetadata](API_DocumentMetadata.md) 
+  [EvaluationMetric](API_EvaluationMetric.md) 
+  [ExpenseCurrency](API_ExpenseCurrency.md) 
+  [ExpenseDetection](API_ExpenseDetection.md) 
+  [ExpenseDocument](API_ExpenseDocument.md) 
+  [ExpenseField](API_ExpenseField.md) 
+  [ExpenseGroupProperty](API_ExpenseGroupProperty.md) 
+  [ExpenseType](API_ExpenseType.md) 
+  [Extraction](API_Extraction.md) 
+  [Geometry](API_Geometry.md) 
+  [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) 
+  [HumanLoopConfig](API_HumanLoopConfig.md) 
+  [HumanLoopDataAttributes](API_HumanLoopDataAttributes.md) 
+  [IdentityDocument](API_IdentityDocument.md) 
+  [IdentityDocumentField](API_IdentityDocumentField.md) 
+  [LendingDetection](API_LendingDetection.md) 
+  [LendingDocument](API_LendingDocument.md) 
+  [LendingField](API_LendingField.md) 
+  [LendingResult](API_LendingResult.md) 
+  [LendingSummary](API_LendingSummary.md) 
+  [LineItemFields](API_LineItemFields.md) 
+  [LineItemGroup](API_LineItemGroup.md) 
+  [NormalizedValue](API_NormalizedValue.md) 
+  [NotificationChannel](API_NotificationChannel.md) 
+  [OutputConfig](API_OutputConfig.md) 
+  [PageClassification](API_PageClassification.md) 
+  [Point](API_Point.md) 
+  [Prediction](API_Prediction.md) 
+  [QueriesConfig](API_QueriesConfig.md) 
+  [Query](API_Query.md) 
+  [Relationship](API_Relationship.md) 
+  [S3Object](API_S3Object.md) 
+  [SignatureDetection](API_SignatureDetection.md) 
+  [SplitDocument](API_SplitDocument.md) 
+  [UndetectedSignature](API_UndetectedSignature.md) 
+  [Warning](API_Warning.md) 

# Adapter
<a name="API_Adapter"></a>

An adapter selected for use when analyzing documents. Contains an adapter ID and a version number. Contains information on pages selected for analysis when analyzing documents asychronously.

## Contents
<a name="API_Adapter_Contents"></a>

 ** AdapterId **   <a name="Textract-Type-Adapter-AdapterId"></a>
A unique identifier for the adapter resource.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.  
Required: Yes

 ** Version **   <a name="Textract-Type-Adapter-Version"></a>
A string that identifies the version of the adapter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** Pages **   <a name="Textract-Type-Adapter-Pages"></a>
Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter.  
+ If a page is not specified, it is set to `["1"]` by default.
+ The following characters are allowed in the parameter's string: `0 1 2 3 4 5 6 7 8 9 - *`. No whitespace is allowed.
+ When using \$1 to indicate all pages, it must be the only element in the list.
+ You can use page intervals, such as `["1-3", "1-1", "4-*"]`. Where `*` indicates last page of document.
+ Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 9.  
Pattern: `^[0-9\*\-]+$`   
Required: No

## See Also
<a name="API_Adapter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Adapter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Adapter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Adapter) 

# AdapterOverview
<a name="API_AdapterOverview"></a>

Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types.

## Contents
<a name="API_AdapterOverview_Contents"></a>

 ** AdapterId **   <a name="Textract-Type-AdapterOverview-AdapterId"></a>
A unique identifier for the adapter resource.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.  
Required: No

 ** AdapterName **   <a name="Textract-Type-AdapterOverview-AdapterName"></a>
A string naming the adapter resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9-_]+`   
Required: No

 ** CreationTime **   <a name="Textract-Type-AdapterOverview-CreationTime"></a>
The date and time that the adapter was created.  
Type: Timestamp  
Required: No

 ** FeatureTypes **   <a name="Textract-Type-AdapterOverview-FeatureTypes"></a>
The feature types that the adapter is operating on.  
Type: Array of strings  
Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT`   
Required: No

## See Also
<a name="API_AdapterOverview_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AdapterOverview) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AdapterOverview) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AdapterOverview) 

# AdaptersConfig
<a name="API_AdaptersConfig"></a>

Contains information about adapters used when analyzing a document, with each adapter specified using an AdapterId and version

## Contents
<a name="API_AdaptersConfig_Contents"></a>

 ** Adapters **   <a name="Textract-Type-AdaptersConfig-Adapters"></a>
A list of adapters to be used when analyzing the specified document.  
Type: Array of [Adapter](API_Adapter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: Yes

## See Also
<a name="API_AdaptersConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AdaptersConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AdaptersConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AdaptersConfig) 

# AdapterVersionDatasetConfig
<a name="API_AdapterVersionDatasetConfig"></a>

The dataset configuration options for a given version of an adapter. Can include an Amazon S3 bucket if specified.

## Contents
<a name="API_AdapterVersionDatasetConfig_Contents"></a>

 ** ManifestS3Object **   <a name="Textract-Type-AdapterVersionDatasetConfig-ManifestS3Object"></a>
The S3 bucket name and file name that identifies the document.  
The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.  
For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.   
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_AdapterVersionDatasetConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AdapterVersionDatasetConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AdapterVersionDatasetConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AdapterVersionDatasetConfig) 

# AdapterVersionEvaluationMetric
<a name="API_AdapterVersionEvaluationMetric"></a>

Contains information on the metrics used to evalute the peformance of a given adapter version. Includes data for baseline model performance and individual adapter version perfromance.

## Contents
<a name="API_AdapterVersionEvaluationMetric_Contents"></a>

 ** AdapterVersion **   <a name="Textract-Type-AdapterVersionEvaluationMetric-AdapterVersion"></a>
The F1 score, precision, and recall metrics for the baseline model.  
Type: [EvaluationMetric](API_EvaluationMetric.md) object  
Required: No

 ** Baseline **   <a name="Textract-Type-AdapterVersionEvaluationMetric-Baseline"></a>
The F1 score, precision, and recall metrics for the baseline model.  
Type: [EvaluationMetric](API_EvaluationMetric.md) object  
Required: No

 ** FeatureType **   <a name="Textract-Type-AdapterVersionEvaluationMetric-FeatureType"></a>
Indicates the feature type being analyzed by a given adapter version.  
Type: String  
Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT`   
Required: No

## See Also
<a name="API_AdapterVersionEvaluationMetric_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AdapterVersionEvaluationMetric) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AdapterVersionEvaluationMetric) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AdapterVersionEvaluationMetric) 

# AdapterVersionOverview
<a name="API_AdapterVersionOverview"></a>

Summary info for an adapter version. Contains information on the AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status.

## Contents
<a name="API_AdapterVersionOverview_Contents"></a>

 ** AdapterId **   <a name="Textract-Type-AdapterVersionOverview-AdapterId"></a>
A unique identifier for the adapter associated with a given adapter version.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 1011.  
Required: No

 ** AdapterVersion **   <a name="Textract-Type-AdapterVersionOverview-AdapterVersion"></a>
An identified for a given adapter version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** CreationTime **   <a name="Textract-Type-AdapterVersionOverview-CreationTime"></a>
The date and time that a given adapter version was created.  
Type: Timestamp  
Required: No

 ** FeatureTypes **   <a name="Textract-Type-AdapterVersionOverview-FeatureTypes"></a>
The feature types that the adapter version is operating on.  
Type: Array of strings  
Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT`   
Required: No

 ** Status **   <a name="Textract-Type-AdapterVersionOverview-Status"></a>
Contains information on the status of a given adapter version.  
Type: String  
Valid Values: `ACTIVE | AT_RISK | DEPRECATED | CREATION_ERROR | CREATION_IN_PROGRESS`   
Required: No

 ** StatusMessage **   <a name="Textract-Type-AdapterVersionOverview-StatusMessage"></a>
A message explaining the status of a given adapter vesion.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$`   
Required: No

## See Also
<a name="API_AdapterVersionOverview_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AdapterVersionOverview) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AdapterVersionOverview) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AdapterVersionOverview) 

# AnalyzeIDDetections
<a name="API_AnalyzeIDDetections"></a>

Used to contain the information detected by an AnalyzeID operation.

## Contents
<a name="API_AnalyzeIDDetections_Contents"></a>

 ** Text **   <a name="Textract-Type-AnalyzeIDDetections-Text"></a>
Text of either the normalized field or value associated with it.  
Type: String  
Required: Yes

 ** Confidence **   <a name="Textract-Type-AnalyzeIDDetections-Confidence"></a>
The confidence score of the detected text.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** NormalizedValue **   <a name="Textract-Type-AnalyzeIDDetections-NormalizedValue"></a>
Only returned for dates, returns the type of value detected and the date written in a more machine readable way.  
Type: [NormalizedValue](API_NormalizedValue.md) object  
Required: No

## See Also
<a name="API_AnalyzeIDDetections_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeIDDetections) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeIDDetections) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeIDDetections) 

# Block
<a name="API_Block"></a>

A `Block` represents items that are recognized in a document within a group of pixels close to each other. The information returned in a `Block` object depends on the type of operation. In text detection for documents (for example [DetectDocumentText](API_DetectDocumentText.md)), you get information about the detected words and lines of text. In text analysis (for example [AnalyzeDocument](API_AnalyzeDocument.md)), you can also get information about the fields, tables, and selection elements that are detected in the document.

An array of `Block` objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as [DetectDocumentText](API_DetectDocumentText.md), the array of `Block` objects is the entire set of results. In asynchronous operations, such as [GetDocumentAnalysis](API_GetDocumentAnalysis.md), the array is returned over one or more responses.

For more information, see [How Amazon Textract Works](https://docs.aws.amazon.com/textract/latest/dg/how-it-works.html).

## Contents
<a name="API_Block_Contents"></a>

 ** BlockType **   <a name="Textract-Type-Block-BlockType"></a>
The type of text item that's recognized. In operations for text detection, the following types are returned:  
+  *PAGE* - Contains a list of the LINE `Block` objects that are detected on a document page.
+  *WORD* - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
+  *LINE* - A string of space-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:  
+  *PAGE* - Contains a list of child `Block` objects that are detected on a document page.
+  *KEY\$1VALUE\$1SET* - Stores the KEY and VALUE `Block` objects for linked text that's detected on a document page. Use the `EntityType` field to determine if a KEY\$1VALUE\$1SET object is a KEY `Block` object or a VALUE `Block` object. 
+  *WORD* - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
+  *LINE* - A string of tab-delimited, contiguous words that are detected on a document page.
+  *TABLE* - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each. 
+  *TABLE\$1TITLE* - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table. 
+  *TABLE\$1FOOTER* - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table. 
+  *CELL* - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
+  *MERGED\$1CELL* - A cell in a table whose content spans more than one row or column. The `Relationships` array for this cell contain data from individual cells.
+  *SELECTION\$1ELEMENT* - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of `SelectionStatus` to determine the status of the selection element.
+  *SIGNATURE* - The location and confidence score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
+  *QUERY* - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
+  *QUERY\$1RESULT* - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
The following BlockTypes are only returned for Amazon Textract Layout.  
+  `LAYOUT_TITLE` - The main title of the document.
+  `LAYOUT_HEADER` - Text located in the top margin of the document.
+  `LAYOUT_FOOTER` - Text located in the bottom margin of the document.
+  `LAYOUT_SECTION_HEADER` - The titles of sections within a document.
+  `LAYOUT_PAGE_NUMBER` - The page number of the documents.
+  `LAYOUT_LIST` - Any information grouped together in list form. 
+  `LAYOUT_FIGURE` - Indicates the location of an image in a document.
+  `LAYOUT_TABLE` - Indicates the location of a table in the document.
+  `LAYOUT_KEY_VALUE` - Indicates the location of form key-values in a document.
+  `LAYOUT_TEXT` - Text that is present typically as a part of paragraphs in documents.
Type: String  
Valid Values: `KEY_VALUE_SET | PAGE | LINE | WORD | TABLE | CELL | SELECTION_ELEMENT | MERGED_CELL | TITLE | QUERY | QUERY_RESULT | SIGNATURE | TABLE_TITLE | TABLE_FOOTER | LAYOUT_TEXT | LAYOUT_TITLE | LAYOUT_HEADER | LAYOUT_FOOTER | LAYOUT_SECTION_HEADER | LAYOUT_PAGE_NUMBER | LAYOUT_LIST | LAYOUT_FIGURE | LAYOUT_TABLE | LAYOUT_KEY_VALUE`   
Required: No

 ** ColumnIndex **   <a name="Textract-Type-Block-ColumnIndex"></a>
The column in which a table cell appears. The first column position is 1. `ColumnIndex` isn't returned by `DetectDocumentText` and `GetDocumentTextDetection`.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** ColumnSpan **   <a name="Textract-Type-Block-ColumnSpan"></a>
The number of columns that a table cell spans. `ColumnSpan` isn't returned by `DetectDocumentText` and `GetDocumentTextDetection`.   
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** Confidence **   <a name="Textract-Type-Block-Confidence"></a>
The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** EntityTypes **   <a name="Textract-Type-Block-EntityTypes"></a>
The type of entity.   
The following entity types can be returned by FORMS analysis:  
+  *KEY* - An identifier for a field on the document.
+  *VALUE* - The field text.
The following entity types can be returned by TABLES analysis:  
+  *COLUMN\$1HEADER* - Identifies a cell that is a header of a column. 
+  *TABLE\$1TITLE* - Identifies a cell that is a title within the table. 
+  *TABLE\$1SECTION\$1TITLE* - Identifies a cell that is a title of a section within a table. A section title is a cell that typically spans an entire row above a section. 
+  *TABLE\$1FOOTER* - Identifies a cell that is a footer of a table. 
+  *TABLE\$1SUMMARY* - Identifies a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table. 
+  *STRUCTURED\$1TABLE * - Identifies a table with column headers where the content of each row corresponds to the headers. 
+  *SEMI\$1STRUCTURED\$1TABLE* - Identifies a non-structured table. 
 `EntityTypes` isn't returned by `DetectDocumentText` and `GetDocumentTextDetection`.  
Type: Array of strings  
Valid Values: `KEY | VALUE | COLUMN_HEADER | TABLE_TITLE | TABLE_FOOTER | TABLE_SECTION_TITLE | TABLE_SUMMARY | STRUCTURED_TABLE | SEMI_STRUCTURED_TABLE`   
Required: No

 ** Geometry **   <a name="Textract-Type-Block-Geometry"></a>
The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.   
Type: [Geometry](API_Geometry.md) object  
Required: No

 ** Id **   <a name="Textract-Type-Block-Id"></a>
The identifier for the recognized text. The identifier is only unique for a single operation.   
Type: String  
Pattern: `.*\S.*`   
Required: No

 ** Page **   <a name="Textract-Type-Block-Page"></a>
The page on which a block was detected. `Page` is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an asynchronous operation, even if it contains multiple document pages, is considered a single-page document. This means that for scanned images the value of `Page` is always 1.   
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** Query **   <a name="Textract-Type-Block-Query"></a>
  
Type: [Query](API_Query.md) object  
Required: No

 ** Relationships **   <a name="Textract-Type-Block-Relationships"></a>
A list of relationship objects that describe how blocks are related to each other. For example, a LINE block object contains a CHILD relationship type with the WORD blocks that make up the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks.  
Type: Array of [Relationship](API_Relationship.md) objects  
Required: No

 ** RowIndex **   <a name="Textract-Type-Block-RowIndex"></a>
The row in which a table cell is located. The first row position is 1. `RowIndex` isn't returned by `DetectDocumentText` and `GetDocumentTextDetection`.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** RowSpan **   <a name="Textract-Type-Block-RowSpan"></a>
The number of rows that a table cell spans. `RowSpan` isn't returned by `DetectDocumentText` and `GetDocumentTextDetection`.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** SelectionStatus **   <a name="Textract-Type-Block-SelectionStatus"></a>
The selection status of a selection element, such as an option button or check box.   
Type: String  
Valid Values: `SELECTED | NOT_SELECTED`   
Required: No

 ** Text **   <a name="Textract-Type-Block-Text"></a>
The word or line of text that's recognized by Amazon Textract.   
Type: String  
Required: No

 ** TextType **   <a name="Textract-Type-Block-TextType"></a>
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.  
Type: String  
Valid Values: `HANDWRITING | PRINTED`   
Required: No

## See Also
<a name="API_Block_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Block) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Block) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Block) 

# BoundingBox
<a name="API_BoundingBox"></a>

The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a document page. The `left` (x-coordinate) and `top` (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0). 

The `top` and `left` values returned are ratios of the overall document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a `left` value of 0.5 (350/700) and a `top` value of 0.25 (50/200).

The `width` and `height` values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. 

## Contents
<a name="API_BoundingBox_Contents"></a>

 ** Height **   <a name="Textract-Type-BoundingBox-Height"></a>
The height of the bounding box as a ratio of the overall document page height.  
Type: Float  
Required: No

 ** Left **   <a name="Textract-Type-BoundingBox-Left"></a>
The left coordinate of the bounding box as a ratio of overall document page width.  
Type: Float  
Required: No

 ** Top **   <a name="Textract-Type-BoundingBox-Top"></a>
The top coordinate of the bounding box as a ratio of overall document page height.  
Type: Float  
Required: No

 ** Width **   <a name="Textract-Type-BoundingBox-Width"></a>
The width of the bounding box as a ratio of the overall document page width.  
Type: Float  
Required: No

## See Also
<a name="API_BoundingBox_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/BoundingBox) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/BoundingBox) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/BoundingBox) 

# DetectedSignature
<a name="API_DetectedSignature"></a>

A structure that holds information regarding a detected signature on a page.

## Contents
<a name="API_DetectedSignature_Contents"></a>

 ** Page **   <a name="Textract-Type-DetectedSignature-Page"></a>
The page a detected signature was found on.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_DetectedSignature_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DetectedSignature) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DetectedSignature) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DetectedSignature) 

# Document
<a name="API_Document"></a>

The input document, either as bytes or as an S3 object.

You pass image bytes to an Amazon Textract API operation by using the `Bytes` property. For example, you would use the `Bytes` property to pass a document loaded from a local file system. Image bytes passed by using the `Bytes` property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations. 

You pass images stored in an S3 bucket to an Amazon Textract API operation by using the `S3Object` property. Documents stored in an S3 bucket don't need to be base64 encoded.

The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.

If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.

For Amazon Textract to process an S3 object, the user must have permission to access the S3 object. 

## Contents
<a name="API_Document_Contents"></a>

 ** Bytes **   <a name="Textract-Type-Document-Bytes"></a>
A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.  
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the `Bytes` field.   
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 1. Maximum length of 10485760.  
Required: No

 ** S3Object **   <a name="Textract-Type-Document-S3Object"></a>
Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.  
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_Document_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Document) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Document) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Document) 

# DocumentGroup
<a name="API_DocumentGroup"></a>

Summary information about documents grouped by the same document type.

## Contents
<a name="API_DocumentGroup_Contents"></a>

 ** DetectedSignatures **   <a name="Textract-Type-DocumentGroup-DetectedSignatures"></a>
A list of the detected signatures found in a document group.  
Type: Array of [DetectedSignature](API_DetectedSignature.md) objects  
Required: No

 ** SplitDocuments **   <a name="Textract-Type-DocumentGroup-SplitDocuments"></a>
An array that contains information about the pages of a document, defined by logical boundary.  
Type: Array of [SplitDocument](API_SplitDocument.md) objects  
Required: No

 ** Type **   <a name="Textract-Type-DocumentGroup-Type"></a>
The type of document that Amazon Textract has detected. See [Analyze Lending Response Objects](https://docs.aws.amazon.com/textract/latest/dg/lending-response-objects.html) for a list of all types returned by Textract.  
Type: String  
Pattern: `.*\S.*`   
Required: No

 ** UndetectedSignatures **   <a name="Textract-Type-DocumentGroup-UndetectedSignatures"></a>
A list of any expected signatures not found in a document group.  
Type: Array of [UndetectedSignature](API_UndetectedSignature.md) objects  
Required: No

## See Also
<a name="API_DocumentGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DocumentGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DocumentGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DocumentGroup) 

# DocumentLocation
<a name="API_DocumentLocation"></a>

The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations.

The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.

## Contents
<a name="API_DocumentLocation_Contents"></a>

 ** S3Object **   <a name="Textract-Type-DocumentLocation-S3Object"></a>
The Amazon S3 bucket that contains the input document.  
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_DocumentLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DocumentLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DocumentLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DocumentLocation) 

# DocumentMetadata
<a name="API_DocumentMetadata"></a>

Information about the input document.

## Contents
<a name="API_DocumentMetadata_Contents"></a>

 ** Pages **   <a name="Textract-Type-DocumentMetadata-Pages"></a>
The number of pages that are detected in the document.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_DocumentMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DocumentMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DocumentMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DocumentMetadata) 

# EvaluationMetric
<a name="API_EvaluationMetric"></a>

The evaluation metrics (F1 score, Precision, and Recall) for an adapter version.

## Contents
<a name="API_EvaluationMetric_Contents"></a>

 ** F1Score **   <a name="Textract-Type-EvaluationMetric-F1Score"></a>
The F1 score for an adapter version.  
Type: Float  
Required: No

 ** Precision **   <a name="Textract-Type-EvaluationMetric-Precision"></a>
The Precision score for an adapter version.  
Type: Float  
Required: No

 ** Recall **   <a name="Textract-Type-EvaluationMetric-Recall"></a>
The Recall score for an adapter version.  
Type: Float  
Required: No

## See Also
<a name="API_EvaluationMetric_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/EvaluationMetric) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/EvaluationMetric) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/EvaluationMetric) 

# ExpenseCurrency
<a name="API_ExpenseCurrency"></a>

Returns the kind of currency detected.

## Contents
<a name="API_ExpenseCurrency_Contents"></a>

 ** Code **   <a name="Textract-Type-ExpenseCurrency-Code"></a>
Currency code for detected currency. the current supported codes are:  
+ USD
+ EUR
+ GBP
+ CAD
+ INR
+ JPY
+ CHF
+ AUD
+ CNY
+ BZR
+ SEK
+ HKD
Type: String  
Required: No

 ** Confidence **   <a name="Textract-Type-ExpenseCurrency-Confidence"></a>
Percentage confideence in the detected currency.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

## See Also
<a name="API_ExpenseCurrency_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseCurrency) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseCurrency) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseCurrency) 

# ExpenseDetection
<a name="API_ExpenseDetection"></a>

An object used to store information about the Value or Label detected by Amazon Textract.

## Contents
<a name="API_ExpenseDetection_Contents"></a>

 ** Confidence **   <a name="Textract-Type-ExpenseDetection-Confidence"></a>
The confidence in detection, as a percentage  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Geometry **   <a name="Textract-Type-ExpenseDetection-Geometry"></a>
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.  
Type: [Geometry](API_Geometry.md) object  
Required: No

 ** Text **   <a name="Textract-Type-ExpenseDetection-Text"></a>
The word or line of text recognized by Amazon Textract  
Type: String  
Required: No

## See Also
<a name="API_ExpenseDetection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseDetection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseDetection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseDetection) 

# ExpenseDocument
<a name="API_ExpenseDocument"></a>

The structure holding all the information returned by AnalyzeExpense

## Contents
<a name="API_ExpenseDocument_Contents"></a>

 ** Blocks **   <a name="Textract-Type-ExpenseDocument-Blocks"></a>
This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.  
Type: Array of [Block](API_Block.md) objects  
Required: No

 ** ExpenseIndex **   <a name="Textract-Type-ExpenseDocument-ExpenseIndex"></a>
Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** LineItemGroups **   <a name="Textract-Type-ExpenseDocument-LineItemGroups"></a>
Information detected on each table of a document, seperated into `LineItems`.  
Type: Array of [LineItemGroup](API_LineItemGroup.md) objects  
Required: No

 ** SummaryFields **   <a name="Textract-Type-ExpenseDocument-SummaryFields"></a>
Any information found outside of a table by Amazon Textract.  
Type: Array of [ExpenseField](API_ExpenseField.md) objects  
Required: No

## See Also
<a name="API_ExpenseDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseDocument) 

# ExpenseField
<a name="API_ExpenseField"></a>

Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection

## Contents
<a name="API_ExpenseField_Contents"></a>

 ** Currency **   <a name="Textract-Type-ExpenseField-Currency"></a>
Shows the kind of currency, both the code and confidence associated with any monatary value detected.  
Type: [ExpenseCurrency](API_ExpenseCurrency.md) object  
Required: No

 ** GroupProperties **   <a name="Textract-Type-ExpenseField-GroupProperties"></a>
Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.  
Type: Array of [ExpenseGroupProperty](API_ExpenseGroupProperty.md) objects  
Required: No

 ** LabelDetection **   <a name="Textract-Type-ExpenseField-LabelDetection"></a>
The explicitly stated label of a detected element.  
Type: [ExpenseDetection](API_ExpenseDetection.md) object  
Required: No

 ** PageNumber **   <a name="Textract-Type-ExpenseField-PageNumber"></a>
The page number the value was detected on.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** Type **   <a name="Textract-Type-ExpenseField-Type"></a>
The implied label of a detected element. Present alongside LabelDetection for explicit elements.  
Type: [ExpenseType](API_ExpenseType.md) object  
Required: No

 ** ValueDetection **   <a name="Textract-Type-ExpenseField-ValueDetection"></a>
The value of a detected element. Present in explicit and implicit elements.  
Type: [ExpenseDetection](API_ExpenseDetection.md) object  
Required: No

## See Also
<a name="API_ExpenseField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseField) 

# ExpenseGroupProperty
<a name="API_ExpenseGroupProperty"></a>

Shows the group that a certain key belongs to. This helps differentiate between names and addresses for different organizations, that can be hard to determine via JSON response.

## Contents
<a name="API_ExpenseGroupProperty_Contents"></a>

 ** Id **   <a name="Textract-Type-ExpenseGroupProperty-Id"></a>
Provides a group Id number, which will be the same for each in the group.  
Type: String  
Required: No

 ** Types **   <a name="Textract-Type-ExpenseGroupProperty-Types"></a>
Informs you on whether the expense group is a name or an address.  
Type: Array of strings  
Required: No

## See Also
<a name="API_ExpenseGroupProperty_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseGroupProperty) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseGroupProperty) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseGroupProperty) 

# ExpenseType
<a name="API_ExpenseType"></a>

An object used to store information about the Type detected by Amazon Textract.

## Contents
<a name="API_ExpenseType_Contents"></a>

 ** Confidence **   <a name="Textract-Type-ExpenseType-Confidence"></a>
The confidence of accuracy, as a percentage.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Text **   <a name="Textract-Type-ExpenseType-Text"></a>
The word or line of text detected by Amazon Textract.  
Type: String  
Required: No

## See Also
<a name="API_ExpenseType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ExpenseType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ExpenseType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ExpenseType) 

# Extraction
<a name="API_Extraction"></a>

Contains information extracted by an analysis operation after using StartLendingAnalysis.

## Contents
<a name="API_Extraction_Contents"></a>

 ** ExpenseDocument **   <a name="Textract-Type-Extraction-ExpenseDocument"></a>
The structure holding all the information returned by AnalyzeExpense  
Type: [ExpenseDocument](API_ExpenseDocument.md) object  
Required: No

 ** IdentityDocument **   <a name="Textract-Type-Extraction-IdentityDocument"></a>
The structure that lists each document processed in an AnalyzeID operation.  
Type: [IdentityDocument](API_IdentityDocument.md) object  
Required: No

 ** LendingDocument **   <a name="Textract-Type-Extraction-LendingDocument"></a>
Holds the structured data returned by AnalyzeDocument for lending documents.  
Type: [LendingDocument](API_LendingDocument.md) object  
Required: No

## See Also
<a name="API_Extraction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Extraction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Extraction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Extraction) 

# Geometry
<a name="API_Geometry"></a>

Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

## Contents
<a name="API_Geometry_Contents"></a>

 ** BoundingBox **   <a name="Textract-Type-Geometry-BoundingBox"></a>
An axis-aligned coarse representation of the location of the recognized item on the document page.  
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Polygon **   <a name="Textract-Type-Geometry-Polygon"></a>
Within the bounding box, a fine-grained polygon around the recognized item.  
Type: Array of [Point](API_Point.md) objects  
Required: No

 ** RotationAngle **   <a name="Textract-Type-Geometry-RotationAngle"></a>
Provides a numerical value corresponding to the rotation of the WORD block. Possible values are 0, 90, 180, and 270.  
Type: Float  
Required: No

## See Also
<a name="API_Geometry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Geometry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Geometry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Geometry) 

# HumanLoopActivationOutput
<a name="API_HumanLoopActivationOutput"></a>

Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.

## Contents
<a name="API_HumanLoopActivationOutput_Contents"></a>

 ** HumanLoopActivationConditionsEvaluationResults **   <a name="Textract-Type-HumanLoopActivationOutput-HumanLoopActivationConditionsEvaluationResults"></a>
Shows the result of condition evaluations, including those conditions which activated a human review.  
Type: String  
Length Constraints: Maximum length of 10240.  
Required: No

 ** HumanLoopActivationReasons **   <a name="Textract-Type-HumanLoopActivationOutput-HumanLoopActivationReasons"></a>
Shows if and why human review was needed.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Required: No

 ** HumanLoopArn **   <a name="Textract-Type-HumanLoopActivationOutput-HumanLoopArn"></a>
The Amazon Resource Name (ARN) of the HumanLoop created.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_HumanLoopActivationOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/HumanLoopActivationOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/HumanLoopActivationOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/HumanLoopActivationOutput) 

# HumanLoopConfig
<a name="API_HumanLoopConfig"></a>

Sets up the human review workflow the document will be sent to if one of the conditions is met. You can also set certain attributes of the image before review. 

## Contents
<a name="API_HumanLoopConfig_Contents"></a>

 ** FlowDefinitionArn **   <a name="Textract-Type-HumanLoopConfig-FlowDefinitionArn"></a>
The Amazon Resource Name (ARN) of the flow definition.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: Yes

 ** HumanLoopName **   <a name="Textract-Type-HumanLoopConfig-HumanLoopName"></a>
The name of the human workflow used for this image. This should be kept unique within a region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-z0-9](-*[a-z0-9])*`   
Required: Yes

 ** DataAttributes **   <a name="Textract-Type-HumanLoopConfig-DataAttributes"></a>
Sets attributes of the input data.  
Type: [HumanLoopDataAttributes](API_HumanLoopDataAttributes.md) object  
Required: No

## See Also
<a name="API_HumanLoopConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/HumanLoopConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/HumanLoopConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/HumanLoopConfig) 

# HumanLoopDataAttributes
<a name="API_HumanLoopDataAttributes"></a>

Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information and adult content. 

## Contents
<a name="API_HumanLoopDataAttributes_Contents"></a>

 ** ContentClassifiers **   <a name="Textract-Type-HumanLoopDataAttributes-ContentClassifiers"></a>
Sets whether the input image is free of personally identifiable information or adult content.  
Type: Array of strings  
Array Members: Maximum number of 256 items.  
Valid Values: `FreeOfPersonallyIdentifiableInformation | FreeOfAdultContent`   
Required: No

## See Also
<a name="API_HumanLoopDataAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/HumanLoopDataAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/HumanLoopDataAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/HumanLoopDataAttributes) 

# IdentityDocument
<a name="API_IdentityDocument"></a>

The structure that lists each document processed in an AnalyzeID operation.

## Contents
<a name="API_IdentityDocument_Contents"></a>

 ** Blocks **   <a name="Textract-Type-IdentityDocument-Blocks"></a>
Individual word recognition, as returned by document detection.  
Type: Array of [Block](API_Block.md) objects  
Required: No

 ** DocumentIndex **   <a name="Textract-Type-IdentityDocument-DocumentIndex"></a>
Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** IdentityDocumentFields **   <a name="Textract-Type-IdentityDocument-IdentityDocumentFields"></a>
The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.  
Type: Array of [IdentityDocumentField](API_IdentityDocumentField.md) objects  
Required: No

## See Also
<a name="API_IdentityDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/IdentityDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/IdentityDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/IdentityDocument) 

# IdentityDocumentField
<a name="API_IdentityDocumentField"></a>

Structure containing both the normalized type of the extracted information and the text associated with it. These are extracted as Type and Value respectively.

## Contents
<a name="API_IdentityDocumentField_Contents"></a>

 ** Type **   <a name="Textract-Type-IdentityDocumentField-Type"></a>
Used to contain the information detected by an AnalyzeID operation.  
Type: [AnalyzeIDDetections](API_AnalyzeIDDetections.md) object  
Required: No

 ** ValueDetection **   <a name="Textract-Type-IdentityDocumentField-ValueDetection"></a>
Used to contain the information detected by an AnalyzeID operation.  
Type: [AnalyzeIDDetections](API_AnalyzeIDDetections.md) object  
Required: No

## See Also
<a name="API_IdentityDocumentField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/IdentityDocumentField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/IdentityDocumentField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/IdentityDocumentField) 

# LendingDetection
<a name="API_LendingDetection"></a>

The results extracted for a lending document.

## Contents
<a name="API_LendingDetection_Contents"></a>

 ** Confidence **   <a name="Textract-Type-LendingDetection-Confidence"></a>
The confidence level for the text of a detected value in a lending document.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Geometry **   <a name="Textract-Type-LendingDetection-Geometry"></a>
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.  
Type: [Geometry](API_Geometry.md) object  
Required: No

 ** SelectionStatus **   <a name="Textract-Type-LendingDetection-SelectionStatus"></a>
The selection status of a selection element, such as an option button or check box.  
Type: String  
Valid Values: `SELECTED | NOT_SELECTED`   
Required: No

 ** Text **   <a name="Textract-Type-LendingDetection-Text"></a>
The text extracted for a detected value in a lending document.  
Type: String  
Required: No

## See Also
<a name="API_LendingDetection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LendingDetection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LendingDetection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LendingDetection) 

# LendingDocument
<a name="API_LendingDocument"></a>

Holds the structured data returned by AnalyzeDocument for lending documents.

## Contents
<a name="API_LendingDocument_Contents"></a>

 ** LendingFields **   <a name="Textract-Type-LendingDocument-LendingFields"></a>
An array of LendingField objects.  
Type: Array of [LendingField](API_LendingField.md) objects  
Required: No

 ** SignatureDetections **   <a name="Textract-Type-LendingDocument-SignatureDetections"></a>
A list of signatures detected in a lending document.  
Type: Array of [SignatureDetection](API_SignatureDetection.md) objects  
Required: No

## See Also
<a name="API_LendingDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LendingDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LendingDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LendingDocument) 

# LendingField
<a name="API_LendingField"></a>

Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.

## Contents
<a name="API_LendingField_Contents"></a>

 ** KeyDetection **   <a name="Textract-Type-LendingField-KeyDetection"></a>
The results extracted for a lending document.  
Type: [LendingDetection](API_LendingDetection.md) object  
Required: No

 ** Type **   <a name="Textract-Type-LendingField-Type"></a>
The type of the lending document.  
Type: String  
Required: No

 ** ValueDetections **   <a name="Textract-Type-LendingField-ValueDetections"></a>
An array of LendingDetection objects.  
Type: Array of [LendingDetection](API_LendingDetection.md) objects  
Required: No

## See Also
<a name="API_LendingField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LendingField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LendingField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LendingField) 

# LendingResult
<a name="API_LendingResult"></a>

Contains the detections for each page analyzed through the Analyze Lending API.

## Contents
<a name="API_LendingResult_Contents"></a>

 ** Extractions **   <a name="Textract-Type-LendingResult-Extractions"></a>
An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections .  
Type: Array of [Extraction](API_Extraction.md) objects  
Required: No

 ** Page **   <a name="Textract-Type-LendingResult-Page"></a>
The page number for a page, with regard to whole submission.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** PageClassification **   <a name="Textract-Type-LendingResult-PageClassification"></a>
The classifier result for a given page.  
Type: [PageClassification](API_PageClassification.md) object  
Required: No

## See Also
<a name="API_LendingResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LendingResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LendingResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LendingResult) 

# LendingSummary
<a name="API_LendingSummary"></a>

Contains information regarding DocumentGroups and UndetectedDocumentTypes.

## Contents
<a name="API_LendingSummary_Contents"></a>

 ** DocumentGroups **   <a name="Textract-Type-LendingSummary-DocumentGroups"></a>
Contains an array of all DocumentGroup objects.  
Type: Array of [DocumentGroup](API_DocumentGroup.md) objects  
Required: No

 ** UndetectedDocumentTypes **   <a name="Textract-Type-LendingSummary-UndetectedDocumentTypes"></a>
UndetectedDocumentTypes.  
Type: Array of strings  
Pattern: `.*\S.*`   
Required: No

## See Also
<a name="API_LendingSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LendingSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LendingSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LendingSummary) 

# LineItemFields
<a name="API_LineItemFields"></a>

A structure that holds information about the different lines found in a document's tables.

## Contents
<a name="API_LineItemFields_Contents"></a>

 ** LineItemExpenseFields **   <a name="Textract-Type-LineItemFields-LineItemExpenseFields"></a>
ExpenseFields used to show information from detected lines on a table.  
Type: Array of [ExpenseField](API_ExpenseField.md) objects  
Required: No

## See Also
<a name="API_LineItemFields_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LineItemFields) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LineItemFields) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LineItemFields) 

# LineItemGroup
<a name="API_LineItemGroup"></a>

A grouping of tables which contain LineItems, with each table identified by the table's `LineItemGroupIndex`.

## Contents
<a name="API_LineItemGroup_Contents"></a>

 ** LineItemGroupIndex **   <a name="Textract-Type-LineItemGroup-LineItemGroupIndex"></a>
The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** LineItems **   <a name="Textract-Type-LineItemGroup-LineItems"></a>
The breakdown of information on a particular line of a table.   
Type: Array of [LineItemFields](API_LineItemFields.md) objects  
Required: No

## See Also
<a name="API_LineItemGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/LineItemGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/LineItemGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/LineItemGroup) 

# NormalizedValue
<a name="API_NormalizedValue"></a>

Contains information relating to dates in a document, including the type of value, and the value.

## Contents
<a name="API_NormalizedValue_Contents"></a>

 ** Value **   <a name="Textract-Type-NormalizedValue-Value"></a>
The value of the date, written as Year-Month-DayTHour:Minute:Second.  
Type: String  
Required: No

 ** ValueType **   <a name="Textract-Type-NormalizedValue-ValueType"></a>
The normalized type of the value detected. In this case, DATE.  
Type: String  
Valid Values: `DATE`   
Required: No

## See Also
<a name="API_NormalizedValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/NormalizedValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/NormalizedValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/NormalizedValue) 

# NotificationChannel
<a name="API_NotificationChannel"></a>

The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation. 

## Contents
<a name="API_NotificationChannel_Contents"></a>

 ** RoleArn **   <a name="Textract-Type-NotificationChannel-RoleArn"></a>
The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Required: Yes

 ** SNSTopicArn **   <a name="Textract-Type-NotificationChannel-SNSTopicArn"></a>
The Amazon SNS topic that Amazon Textract posts the completion status to.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 1024.  
Pattern: `(^arn:([a-z\d-]+):sns:[a-zA-Z\d-]{1,20}:\w{12}:.+$)`   
Required: Yes

## See Also
<a name="API_NotificationChannel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/NotificationChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/NotificationChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/NotificationChannel) 

# OutputConfig
<a name="API_OutputConfig"></a>

Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

 `OutputConfig` is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With `OutputConfig` enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the `KMSKeyID` parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.

Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see [ Managing AI services opt-out policy. ](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) 

For more information on data privacy, see the [Data Privacy FAQ](https://aws.amazon.com/compliance/data-privacy-faq/).

## Contents
<a name="API_OutputConfig_Contents"></a>

 ** S3Bucket **   <a name="Textract-Type-OutputConfig-S3Bucket"></a>
The name of the bucket your output will go to.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[0-9A-Za-z\.\-_]*`   
Required: Yes

 ** S3Prefix **   <a name="Textract-Type-OutputConfig-S3Prefix"></a>
The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract\$1output".  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*`   
Required: No

## See Also
<a name="API_OutputConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/OutputConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/OutputConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/OutputConfig) 

# PageClassification
<a name="API_PageClassification"></a>

The class assigned to a Page object detected in an input document. Contains information regarding the predicted type/class of a document's page and the page number that the Page object was detected on.

## Contents
<a name="API_PageClassification_Contents"></a>

 ** PageNumber **   <a name="Textract-Type-PageClassification-PageNumber"></a>
 The page number the value was detected on, relative to Amazon Textract's starting position.  
Type: Array of [Prediction](API_Prediction.md) objects  
Required: Yes

 ** PageType **   <a name="Textract-Type-PageClassification-PageType"></a>
The class, or document type, assigned to a detected Page object. The class, or document type, assigned to a detected Page object.  
Type: Array of [Prediction](API_Prediction.md) objects  
Required: Yes

## See Also
<a name="API_PageClassification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/PageClassification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/PageClassification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/PageClassification) 

# Point
<a name="API_Point"></a>

The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.

An array of `Point` objects, `Polygon`, is returned as part of the [Geometry](API_Geometry.md) object that's returned in a [Block](API_Block.md) object. A `Polygon` object represents a fine-grained polygon around detected text, a key-value pair, a table, a table cell, or a selection element. 

## Contents
<a name="API_Point_Contents"></a>

 ** X **   <a name="Textract-Type-Point-X"></a>
The value of the X coordinate for a point on a `Polygon`.  
Type: Float  
Required: No

 ** Y **   <a name="Textract-Type-Point-Y"></a>
The value of the Y coordinate for a point on a `Polygon`.  
Type: Float  
Required: No

## See Also
<a name="API_Point_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Point) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Point) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Point) 

# Prediction
<a name="API_Prediction"></a>

Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value and the confidence in the predicted value.

## Contents
<a name="API_Prediction_Contents"></a>

 ** Confidence **   <a name="Textract-Type-Prediction-Confidence"></a>
Amazon Textract's confidence in its predicted value.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Value **   <a name="Textract-Type-Prediction-Value"></a>
The predicted value of a detected object.  
Type: String  
Pattern: `.*\S.*`   
Required: No

## See Also
<a name="API_Prediction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Prediction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Prediction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Prediction) 

# QueriesConfig
<a name="API_QueriesConfig"></a>



## Contents
<a name="API_QueriesConfig_Contents"></a>

 ** Queries **   <a name="Textract-Type-QueriesConfig-Queries"></a>
  
Type: Array of [Query](API_Query.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_QueriesConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/QueriesConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/QueriesConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/QueriesConfig) 

# Query
<a name="API_Query"></a>

Each query contains the question you want to ask in the Text and the alias you want to associate.

## Contents
<a name="API_Query_Contents"></a>

 ** Text **   <a name="Textract-Type-Query-Text"></a>
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$`   
Required: Yes

 ** Alias **   <a name="Textract-Type-Query-Alias"></a>
Alias attached to the query, for ease of location.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$`   
Required: No

 ** Pages **   <a name="Textract-Type-Query-Pages"></a>
Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.  
+ If a page is not specified, it is set to `["1"]` by default.
+ The following characters are allowed in the parameter's string: `0 1 2 3 4 5 6 7 8 9 - *`. No whitespace is allowed.
+ When using \$1 to indicate all pages, it must be the only element in the list.
+ You can use page intervals, such as `[“1-3”, “1-1”, “4-*”]`. Where `*` indicates last page of document.
+ Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 9.  
Pattern: `^[0-9\*\-]+$`   
Required: No

## See Also
<a name="API_Query_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Query) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Query) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Query) 

# Relationship
<a name="API_Relationship"></a>

Information about how blocks are related to each other. A `Block` object contains 0 or more `Relation` objects in a list, `Relationships`. For more information, see [Block](API_Block.md).

The `Type` element provides the type of the relationship for all blocks in the `IDs` array. 

## Contents
<a name="API_Relationship_Contents"></a>

 ** Ids **   <a name="Textract-Type-Relationship-Ids"></a>
An array of IDs for related blocks. You can get the type of the relationship from the `Type` element.  
Type: Array of strings  
Pattern: `.*\S.*`   
Required: No

 ** Type **   <a name="Textract-Type-Relationship-Type"></a>
The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.   
+  *VALUE* - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.
+  *CHILD* - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.
+  *MERGED\$1CELL* - A list of IDs that identify each of the MERGED\$1CELL block types in a table.
+  *ANSWER* - A list that contains the ID of the QUERY\$1RESULT block that’s associated with the corresponding QUERY block. 
+  *TABLE* - A list of IDs that identify associated TABLE block types. 
+  *TABLE\$1TITLE* - A list that contains the ID for the TABLE\$1TITLE block type in a table. 
+  *TABLE\$1FOOTER* - A list of IDs that identify the TABLE\$1FOOTER block types in a table. 
Type: String  
Valid Values: `VALUE | CHILD | COMPLEX_FEATURES | MERGED_CELL | TITLE | ANSWER | TABLE | TABLE_TITLE | TABLE_FOOTER`   
Required: No

## See Also
<a name="API_Relationship_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Relationship) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Relationship) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Relationship) 

# S3Object
<a name="API_S3Object"></a>

The S3 bucket name and file name that identifies the document.

The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.

For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file. 

## Contents
<a name="API_S3Object_Contents"></a>

 ** Bucket **   <a name="Textract-Type-S3Object-Bucket"></a>
The name of the S3 bucket. Note that the \$1 character is not valid in the file name.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[0-9A-Za-z\.\-_]*`   
Required: No

 ** Name **   <a name="Textract-Type-S3Object-Name"></a>
The file name of the input document. Image files may be in PDF, TIFF, JPEG, or PNG format.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*`   
Required: No

 ** Version **   <a name="Textract-Type-S3Object-Version"></a>
If the bucket has versioning enabled, you can specify the object version.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*\S.*`   
Required: No

## See Also
<a name="API_S3Object_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/S3Object) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/S3Object) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/S3Object) 

# SignatureDetection
<a name="API_SignatureDetection"></a>

Information regarding a detected signature on a page.

## Contents
<a name="API_SignatureDetection_Contents"></a>

 ** Confidence **   <a name="Textract-Type-SignatureDetection-Confidence"></a>
The confidence, from 0 to 100, in the predicted values for a detected signature.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Geometry **   <a name="Textract-Type-SignatureDetection-Geometry"></a>
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.  
Type: [Geometry](API_Geometry.md) object  
Required: No

## See Also
<a name="API_SignatureDetection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/SignatureDetection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/SignatureDetection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/SignatureDetection) 

# SplitDocument
<a name="API_SplitDocument"></a>

Contains information about the pages of a document, defined by logical boundary.

## Contents
<a name="API_SplitDocument_Contents"></a>

 ** Index **   <a name="Textract-Type-SplitDocument-Index"></a>
The index for a given document in a DocumentGroup of a specific Type.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** Pages **   <a name="Textract-Type-SplitDocument-Pages"></a>
An array of page numbers for a for a given document, ordered by logical boundary.  
Type: Array of integers  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_SplitDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/SplitDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/SplitDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/SplitDocument) 

# UndetectedSignature
<a name="API_UndetectedSignature"></a>

A structure containing information about an undetected signature on a page where it was expected but not found.

## Contents
<a name="API_UndetectedSignature_Contents"></a>

 ** Page **   <a name="Textract-Type-UndetectedSignature-Page"></a>
The page where a signature was expected but not found.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_UndetectedSignature_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/UndetectedSignature) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/UndetectedSignature) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/UndetectedSignature) 

# Warning
<a name="API_Warning"></a>

A warning about an issue that occurred during asynchronous text analysis ([StartDocumentAnalysis](API_StartDocumentAnalysis.md)) or asynchronous document text detection ([StartDocumentTextDetection](API_StartDocumentTextDetection.md)). 

## Contents
<a name="API_Warning_Contents"></a>

 ** ErrorCode **   <a name="Textract-Type-Warning-ErrorCode"></a>
The error code for the warning.  
Type: String  
Required: No

 ** Pages **   <a name="Textract-Type-Warning-Pages"></a>
A list of the pages that the warning applies to.  
Type: Array of integers  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_Warning_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/Warning) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/Warning) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/Warning)