# 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)