Serialized Form (AWS Java SDK for Amazon Textract 1.11.590 API)

Package com.amazonaws.services.textract.model
- Class com.amazonaws.services.textract.model.AccessDeniedException extends AmazonTextractException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.AmazonTextractException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.AnalyzeDocumentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - document
```
Document document
```
      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 JPG or PNG format.
      
      If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.
    - featureTypes
```
List<E> featureTypes
```
      A list of the types of analysis to perform. Add TABLES to the list to return information about the tables detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes.
- Class com.amazonaws.services.textract.model.AnalyzeDocumentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - documentMetadata
```
DocumentMetadata documentMetadata
```
      Metadata about the analyzed document. An example is the number of pages.
    - blocks
```
List<E> blocks
```
      The text that's detected and analyzed by AnalyzeDocument.
- Class com.amazonaws.services.textract.model.BadDocumentException extends AmazonTextractException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.Block extends Object implements Serializable
  - Serialized Fields
    - blockType
```
String blockType
```
      The type of text that's recognized in a block. In text-detection operations, 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 tab-delimited, contiguous words that's 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_VALUE_SET - Stores the KEY and VALUE Block objects for a field that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
      
      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 that's detected on a document page.
      
      LINE - A string of tab-delimited, contiguous words that's detected on a document page.
      
      TABLE - A table that's detected on a document page. A table is any grid-based information with 2 or more rows or columns with a cell span of 1 row and 1 column each.
      
      CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
      
      SELECTION_ELEMENT - A selectable element such as a radio button or checkbox that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
    - confidence
```
Float confidence
```
      The confidence that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
    - text
```
String text
```
      The word or line of text that's recognized by Amazon Textract.
    - rowIndex
```
Integer rowIndex
```
      The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
    - columnIndex
```
Integer columnIndex
```
      The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
    - rowSpan
```
Integer rowSpan
```
      The number of rows that a table spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
    - columnSpan
```
Integer columnSpan
```
      The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
    - geometry
```
Geometry geometry
```
      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.
    - id
```
String id
```
      The identifier for the recognized text. The identifier is only unique for a single operation.
    - relationships
```
List<E> relationships
```
      A list of child blocks of the current block. For example a LINE object has child blocks for each WORD block that's part of 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. The list size can be the following:
      
      0 - The block has no child blocks.
      
      1 - The block has child blocks.
    - entityTypes
```
List<E> entityTypes
```
      The type of entity. The following can be returned:
      
      KEY - An identifier for a field on the document.
      
      VALUE - The field text.
      
      EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
    - selectionStatus
```
String selectionStatus
```
      The selection status of a selectable element such as a radio button or checkbox.
    - page
```
Integer page
```
      The page in which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multi-page documents that are in PDF format. A scanned image (JPG/PNG), even if it contains multiple document pages, is always considered to be a single-page document and the value of Page is always 1. Synchronous operations don't return Page as every input document is considered to be a single-page document.
- Class com.amazonaws.services.textract.model.BoundingBox extends Object implements Serializable
  - Serialized Fields
    - width
```
Float width
```
      The width of the bounding box as a ratio of the overall document page width.
    - height
```
Float height
```
      The height of the bounding box as a ratio of the overall document page height.
    - left
```
Float left
```
      The left coordinate of the bounding box as a ratio of overall document page width.
    - top
```
Float top
```
      The top coordinate of the bounding box as a ratio of overall document page height.
- Class com.amazonaws.services.textract.model.DetectDocumentTextRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - document
```
Document document
```
      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 JPG or PNG format.
      
      If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.
- Class com.amazonaws.services.textract.model.DetectDocumentTextResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - documentMetadata
```
DocumentMetadata documentMetadata
```
      Metadata about the document. Contains the number of pages that are detected in the document.
    - blocks
```
List<E> blocks
```
      An array of Block objects containing the text detected in the document.
- Class com.amazonaws.services.textract.model.Document extends Object implements Serializable
  - Serialized Fields
    - bytes
```
ByteBuffer bytes
```
      A blob of base-64 encoded documents 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 JPG format.
      
      If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.
    - s3Object
```
S3Object s3Object
```
      Identifies an S3 object as the document source. The maximum size of a document stored in an S3 bucket is 5 MB.
- Class com.amazonaws.services.textract.model.DocumentLocation extends Object implements Serializable
  - Serialized Fields
    - s3Object
```
S3Object s3Object
```
      The Amazon S3 bucket that contains the input document.
- Class com.amazonaws.services.textract.model.DocumentMetadata extends Object implements Serializable
  - Serialized Fields
    - pages
```
Integer pages
```
      The number of pages detected in the document.
- Class com.amazonaws.services.textract.model.DocumentTooLargeException extends AmazonTextractException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.Geometry extends Object implements Serializable
  - Serialized Fields
    - boundingBox
```
BoundingBox boundingBox
```
      An axis-aligned coarse representation of the location of the recognized text on the document page.
    - polygon
```
List<E> polygon
```
      Within the bounding box, a fine-grained polygon around the recognized text.
- Class com.amazonaws.services.textract.model.GetDocumentAnalysisRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis.
    - maxResults
```
Integer maxResults
```
      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.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.textract.model.GetDocumentAnalysisResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - documentMetadata
```
DocumentMetadata documentMetadata
```
      Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
    - jobStatus
```
String jobStatus
```
      The current status of the text detection job.
    - nextToken
```
String nextToken
```
      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.
    - blocks
```
List<E> blocks
```
      The results of the text analysis operation.
    - warnings
```
List<E> warnings
```
      A list of warnings that occurred during the document analysis operation.
    - statusMessage
```
String statusMessage
```
      The current status of an asynchronous document analysis operation.
- Class com.amazonaws.services.textract.model.GetDocumentTextDetectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection.
    - maxResults
```
Integer maxResults
```
      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.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.textract.model.GetDocumentTextDetectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - documentMetadata
```
DocumentMetadata documentMetadata
```
      Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
    - jobStatus
```
String jobStatus
```
      The current status of the text detection job.
    - nextToken
```
String nextToken
```
      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.
    - blocks
```
List<E> blocks
```
      The results of the text-detection operation.
    - warnings
```
List<E> warnings
```
      A list of warnings that occurred during the document text-detection operation.
    - statusMessage
```
String statusMessage
```
      The current status of an asynchronous document text-detection operation.
- Class com.amazonaws.services.textract.model.IdempotentParameterMismatchException extends AmazonTextractException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.InternalServerErrorException extends AmazonTextractException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.InvalidJobIdException extends AmazonTextractException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.InvalidParameterException extends AmazonTextractException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.InvalidS3ObjectException extends AmazonTextractException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.LimitExceededException extends AmazonTextractException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.NotificationChannel extends Object implements Serializable
  - Serialized Fields
    - sNSTopicArn
```
String sNSTopicArn
```
      The Amazon SNS topic that Amazon Textract posts the completion status to.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
- Class com.amazonaws.services.textract.model.Point extends Object implements Serializable
  - Serialized Fields
    - x
```
Float x
```
      The value of the X coordinate for a point on a Polygon.
    - y
```
Float y
```
      The value of the Y coordinate for a point on a Polygon.
- Class com.amazonaws.services.textract.model.ProvisionedThroughputExceededException extends AmazonTextractException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.Relationship extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD.
    - ids
```
List<E> ids
```
      An array of IDs for related blocks. You can get the type of the relationship from the Type element.
- Class com.amazonaws.services.textract.model.S3Object extends Object implements Serializable
  - Serialized Fields
    - bucket
```
String bucket
```
      The name of the S3 bucket.
    - name
```
String name
```
      The file name of the input document. It must be an image file (.JPG or .PNG format). Asynchronous operations also support PDF files.
    - version
```
String version
```
      If the bucket has versioning enabled, you can specify the object version.
- Class com.amazonaws.services.textract.model.StartDocumentAnalysisRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - documentLocation
```
DocumentLocation documentLocation
```
      The location of the document to be processed.
    - featureTypes
```
List<E> featureTypes
```
      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 fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements ( SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.
    - clientRequestToken
```
String clientRequestToken
```
      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.
    - jobTag
```
String jobTag
```
      An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.
    - notificationChannel
```
NotificationChannel notificationChannel
```
      The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
- Class com.amazonaws.services.textract.model.StartDocumentAnalysisResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier for the document text detection job. Use JobId to identify the job in a subsequent call to GetDocumentAnalysis.
- Class com.amazonaws.services.textract.model.StartDocumentTextDetectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - documentLocation
```
DocumentLocation documentLocation
```
      The location of the document to be processed.
    - clientRequestToken
```
String clientRequestToken
```
      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.
    - jobTag
```
String jobTag
```
      An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.
    - notificationChannel
```
NotificationChannel notificationChannel
```
      The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
- Class com.amazonaws.services.textract.model.StartDocumentTextDetectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier for the document text-detection job. Use JobId to identify the job in a subsequent call to GetDocumentTextDetection.
- Class com.amazonaws.services.textract.model.ThrottlingException extends AmazonTextractException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.UnsupportedDocumentException extends AmazonTextractException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.textract.model.Warning extends Object implements Serializable
  - Serialized Fields
    - errorCode
```
String errorCode
```
      The error code for the warning.
    - pages
```
List<E> pages
```
      A list of the pages that the warning applies to.

Serialized Form

Package com.amazonaws.services.textract.model

Class com.amazonaws.services.textract.model.AccessDeniedException extends AmazonTextractException implements Serializable

Class com.amazonaws.services.textract.model.AmazonTextractException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.textract.model.AnalyzeDocumentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

document

featureTypes

Class com.amazonaws.services.textract.model.AnalyzeDocumentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

documentMetadata

blocks

Class com.amazonaws.services.textract.model.BadDocumentException extends AmazonTextractException implements Serializable

Class com.amazonaws.services.textract.model.Block extends Object implements Serializable

Serialized Fields

blockType

confidence

text

rowIndex

columnIndex

rowSpan

columnSpan

geometry

id

relationships

entityTypes

selectionStatus

page

Class com.amazonaws.services.textract.model.BoundingBox extends Object implements Serializable

Serialized Fields

width

height

left

top

Class com.amazonaws.services.textract.model.DetectDocumentTextRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

document

Class com.amazonaws.services.textract.model.DetectDocumentTextResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

documentMetadata

blocks

Class com.amazonaws.services.textract.model.Document extends Object implements Serializable

Serialized Fields

bytes

s3Object

Class com.amazonaws.services.textract.model.DocumentLocation extends Object implements Serializable

Serialized Fields

s3Object

Class com.amazonaws.services.textract.model.DocumentMetadata extends Object implements Serializable

Serialized Fields

pages

Class com.amazonaws.services.textract.model.DocumentTooLargeException extends AmazonTextractException implements Serializable

Class com.amazonaws.services.textract.model.Geometry extends Object implements Serializable

Serialized Fields

boundingBox

polygon

Class com.amazonaws.services.textract.model.GetDocumentAnalysisRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

maxResults

nextToken

Class com.amazonaws.services.textract.model.GetDocumentAnalysisResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

documentMetadata

jobStatus

nextToken

blocks

warnings

statusMessage

Class com.amazonaws.services.textract.model.GetDocumentTextDetectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

maxResults

nextToken

Class com.amazonaws.services.textract.model.GetDocumentTextDetectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

documentMetadata

jobStatus

nextToken

blocks