String adapterId
A unique identifier for the adapter resource.
List<E> pages
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 * 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.
String version
A string that identifies the version of the adapter.
String adapterId
A unique identifier for the adapter resource.
String adapterName
A string naming the adapter resource.
Date creationTime
The date and time that the adapter was created.
List<E> featureTypes
The feature types that the adapter is operating on.
S3Object manifestS3Object
EvaluationMetric baseline
The F1 score, precision, and recall metrics for the baseline model.
EvaluationMetric adapterVersion
The F1 score, precision, and recall metrics for the baseline model.
String featureType
Indicates the feature type being analyzed by a given adapter version.
String adapterId
A unique identifier for the adapter associated with a given adapter version.
String adapterVersion
An identified for a given adapter version.
Date creationTime
The date and time that a given adapter version was created.
List<E> featureTypes
The feature types that the adapter version is operating on.
String status
Contains information on the status of a given adapter version.
String statusMessage
A message explaining the status of a given adapter vesion.
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 JPEG, PNG, PDF, or TIFF format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are
passed using the Bytes field.
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 form data. Add SIGNATURES to return the
locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document.
All lines and words detected in the document are included in the response (including text that isn't related to
the value of FeatureTypes).
HumanLoopConfig humanLoopConfig
Sets the configuration for the human in the loop workflow for analyzing documents.
QueriesConfig queriesConfig
Contains Queries and the alias for those Queries, as determined by the input.
AdaptersConfig adaptersConfig
Specifies the adapter to be used when analyzing a document.
DocumentMetadata documentMetadata
Metadata about the analyzed document. An example is the number of pages.
List<E> blocks
The items that are detected and analyzed by AnalyzeDocument.
HumanLoopActivationOutput humanLoopActivationOutput
Shows the results of the human in the loop evaluation.
String analyzeDocumentModelVersion
The version of the model used to analyze the document.
Document document
DocumentMetadata documentMetadata
List<E> expenseDocuments
The expenses detected by Amazon Textract.
String text
Text of either the normalized field or value associated with it.
NormalizedValue normalizedValue
Only returned for dates, returns the type of value detected and the date written in a more machine readable way.
Float confidence
The confidence score of the detected text.
List<E> identityDocuments
The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.
DocumentMetadata documentMetadata
String analyzeIDModelVersion
The version of the AnalyzeIdentity API being used to process documents.
String blockType
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 tab-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_VALUE_SET - 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_VALUE_SET 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_TITLE - 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_FOOTER - 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_CELL - 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_ELEMENT - 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_RESULT - 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.
Float confidence
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.
String text
The word or line of text that's recognized by Amazon Textract.
String textType
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
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.
Integer columnIndex
The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned
by DetectDocumentText and GetDocumentTextDetection.
Integer rowSpan
The number of rows that a table cell spans. RowSpan isn't returned by
DetectDocumentText and GetDocumentTextDetection.
Integer columnSpan
The number of columns that a table cell spans. ColumnSpan isn't returned by
DetectDocumentText and GetDocumentTextDetection.
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.
String id
The identifier for the recognized text. The identifier is only unique for a single operation.
List<E> relationships
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.
List<E> entityTypes
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_HEADER - Identifies a cell that is a header of a column.
TABLE_TITLE - Identifies a cell that is a title within the table.
TABLE_SECTION_TITLE - 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_FOOTER - Identifies a cell that is a footer of a table.
TABLE_SUMMARY - 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_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.
SEMI_STRUCTURED_TABLE - Identifies a non-structured table.
EntityTypes isn't returned by DetectDocumentText and
GetDocumentTextDetection.
String selectionStatus
The selection status of a selection element, such as an option button or check box.
Integer page
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.
Query query
Float width
The width of the bounding box as a ratio of the overall document page width.
Float height
The height of the bounding box as a ratio of the overall document page height.
Float left
The left coordinate of the bounding box as a ratio of overall document page width.
Float top
The top coordinate of the bounding box as a ratio of overall document page height.
String adapterName
The name to be assigned to the adapter being created.
String clientRequestToken
Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.
String description
The description to be assigned to the adapter being created.
List<E> featureTypes
The type of feature that the adapter is being trained on. Currrenly, supported feature types are:
QUERIES
String autoUpdate
Controls whether or not the adapter should automatically update.
Map<K,V> tags
A list of tags to be added to the adapter.
String adapterId
A string containing the unique ID for the adapter that has been created.
String adapterId
A string containing a unique ID for the adapter that will receive a new version.
String clientRequestToken
Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapterVersion requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.
AdapterVersionDatasetConfig datasetConfig
Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the value.
String kMSKeyId
The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.
OutputConfig outputConfig
Map<K,V> tags
A set of tags (key-value pairs) that you want to attach to the adapter version.
String adapterId
A string containing a unique ID for the adapter to be deleted.
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 JPEG or PNG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are
passed using the Bytes field.
DocumentMetadata documentMetadata
Metadata about the document. It contains the number of pages that are detected in the document.
List<E> blocks
An array of Block objects that contain the text that's detected in the document.
String detectDocumentTextModelVersion
Integer page
The page a detected signature was found on.
ByteBuffer bytes
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.
S3Object s3Object
Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.
String type
The type of document that Amazon Textract has detected. See Analyze Lending Response Objects for a list of all types returned by Textract.
List<E> splitDocuments
An array that contains information about the pages of a document, defined by logical boundary.
List<E> detectedSignatures
A list of the detected signatures found in a document group.
List<E> undetectedSignatures
A list of any expected signatures not found in a document group.
S3Object s3Object
The Amazon S3 bucket that contains the input document.
Integer pages
The number of pages that are detected in the document.
Integer expenseIndex
Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.
List<E> summaryFields
Any information found outside of a table by Amazon Textract.
List<E> lineItemGroups
Information detected on each table of a document, seperated into LineItems.
List<E> blocks
This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.
ExpenseType type
The implied label of a detected element. Present alongside LabelDetection for explicit elements.
ExpenseDetection labelDetection
The explicitly stated label of a detected element.
ExpenseDetection valueDetection
The value of a detected element. Present in explicit and implicit elements.
Integer pageNumber
The page number the value was detected on.
ExpenseCurrency currency
Shows the kind of currency, both the code and confidence associated with any monatary value detected.
List<E> groupProperties
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.
LendingDocument lendingDocument
Holds the structured data returned by AnalyzeDocument for lending documents.
ExpenseDocument expenseDocument
IdentityDocument identityDocument
BoundingBox boundingBox
An axis-aligned coarse representation of the location of the recognized item on the document page.
List<E> polygon
Within the bounding box, a fine-grained polygon around the recognized item.
String adapterId
A string containing a unique ID for the adapter.
String adapterId
A string identifying the adapter that information has been retrieved for.
String adapterName
The name of the requested adapter.
Date creationTime
The date and time the requested adapter was created at.
String description
The description for the requested adapter.
List<E> featureTypes
List of the targeted feature types for the requested adapter.
String autoUpdate
Binary value indicating if the adapter is being automatically updated or not.
Map<K,V> tags
A set of tags (key-value pairs) associated with the adapter that has been retrieved.
String adapterId
A string containing a unique ID for the adapter version being retrieved.
String adapterVersion
A string containing the adapter version that has been retrieved.
Date creationTime
The time that the adapter version was created.
List<E> featureTypes
List of the targeted feature types for the requested adapter version.
String status
The status of the adapter version that has been requested.
String statusMessage
A message that describes the status of the requested adapter version.
AdapterVersionDatasetConfig datasetConfig
Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.
String kMSKeyId
The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.
OutputConfig outputConfig
List<E> evaluationMetrics
The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
Map<K,V> tags
A set of tags (key-value pairs) that are associated with the adapter version.
String jobId
A unique identifier for the text-detection job. The JobId is returned from
StartDocumentAnalysis. A JobId value is only valid for 7 days.
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.
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.
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.
String jobStatus
The current status of the text detection job.
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.
List<E> blocks
The results of the text-analysis operation.
List<E> warnings
A list of warnings that occurred during the document-analysis operation.
String statusMessage
Returns if the detection job could not be completed. Contains explanation for what error occured.
String analyzeDocumentModelVersion
String jobId
A unique identifier for the text detection job. The JobId is returned from
StartDocumentTextDetection. A JobId value is only valid for 7 days.
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.
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.
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.
String jobStatus
The current status of the text detection job.
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.
List<E> blocks
The results of the text-detection operation.
List<E> warnings
A list of warnings that occurred during the text-detection operation for the document.
String statusMessage
Returns if the detection job could not be completed. Contains explanation for what error occured.
String detectDocumentTextModelVersion
String jobId
A unique identifier for the text detection job. The JobId is returned from
StartExpenseAnalysis. A JobId value is only valid for 7 days.
Integer maxResults
The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.
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.
DocumentMetadata documentMetadata
Information about a document that Amazon Textract processed. DocumentMetadata is returned in every
page of paginated responses from an Amazon Textract operation.
String jobStatus
The current status of the text detection job.
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.
List<E> expenseDocuments
The expenses detected by Amazon Textract.
List<E> warnings
A list of warnings that occurred during the text-detection operation for the document.
String statusMessage
Returns if the detection job could not be completed. Contains explanation for what error occured.
String analyzeExpenseModelVersion
The current model version of AnalyzeExpense.
String jobId
A unique identifier for the lending or text-detection job. The JobId is returned from
StartLendingAnalysis. A JobId value is only valid for 7 days.
Integer maxResults
The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.
String nextToken
If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.
DocumentMetadata documentMetadata
String jobStatus
The current status of the lending analysis job.
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 lending results.
List<E> results
Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.
List<E> warnings
A list of warnings that occurred during the lending analysis operation.
String statusMessage
Returns if the lending analysis job could not be completed. Contains explanation for what error occurred.
String analyzeLendingModelVersion
The current model version of the Analyze Lending API.
String jobId
A unique identifier for the lending or text-detection job. The JobId is returned from
StartLendingAnalysis. A JobId value is only valid for 7 days.
DocumentMetadata documentMetadata
String jobStatus
The current status of the lending analysis job.
LendingSummary summary
Contains summary information for documents grouped by type.
List<E> warnings
A list of warnings that occurred during the lending analysis operation.
String statusMessage
Returns if the lending analysis could not be completed. Contains explanation for what error occurred.
String analyzeLendingModelVersion
The current model version of the Analyze Lending API.
String humanLoopArn
The Amazon Resource Name (ARN) of the HumanLoop created.
List<E> humanLoopActivationReasons
Shows if and why human review was needed.
String humanLoopActivationConditionsEvaluationResults
Shows the result of condition evaluations, including those conditions which activated a human review.
String humanLoopName
The name of the human workflow used for this image. This should be kept unique within a region.
String flowDefinitionArn
The Amazon Resource Name (ARN) of the flow definition.
HumanLoopDataAttributes dataAttributes
Sets attributes of the input data.
Integer documentIndex
Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.
List<E> identityDocumentFields
The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.
List<E> blocks
Individual word recognition, as returned by document detection.
AnalyzeIDDetections type
AnalyzeIDDetections valueDetection
String text
The text extracted for a detected value in a lending document.
String selectionStatus
The selection status of a selection element, such as an option button or check box.
Geometry geometry
Float confidence
The confidence level for the text of a detected value in a lending document.
String type
The type of the lending document.
LendingDetection keyDetection
List<E> valueDetections
An array of LendingDetection objects.
Integer page
The page number for a page, with regard to whole submission.
PageClassification pageClassification
The classifier result for a given page.
List<E> extractions
An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections .
Date afterCreationTime
Specifies the lower bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created after the specified creation time.
Date beforeCreationTime
Specifies the upper bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created before the specified creation time.
Integer maxResults
The maximum number of results to return when listing adapters.
String nextToken
Identifies the next page of results to return when listing adapters.
String adapterId
A string containing a unique ID for the adapter to match for when listing adapter versions.
Date afterCreationTime
Specifies the lower bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.
Date beforeCreationTime
Specifies the upper bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.
Integer maxResults
The maximum number of results to return when listing adapter versions.
String nextToken
Identifies the next page of results to return when listing adapter versions.
String resourceARN
The Amazon Resource Name (ARN) that specifies the resource to list tags for.
String text
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
String alias
Alias attached to the query, for ease of location.
List<E> pages
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 * 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.
String type
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_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.
ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.
TABLE - A list of IDs that identify associated TABLE block types.
TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.
TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.
List<E> ids
An array of IDs for related blocks. You can get the type of the relationship from the Type element.
String bucket
The name of the S3 bucket. Note that the # character is not valid in the file name.
String name
The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.
String version
If the bucket has versioning enabled, you can specify the object version.
DocumentLocation documentLocation
The location of the document to be processed.
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 form data. To perform both types of analysis,
add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in
the response (including text that isn't related to the value of FeatureTypes).
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. For more
information, see Calling Amazon Textract
Asynchronous Operations.
String jobTag
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic.
For example, you can use JobTag to identify the type of document that the completion notification
corresponds to (such as a tax form or a receipt).
NotificationChannel notificationChannel
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
OutputConfig outputConfig
Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.
String kMSKeyId
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.
QueriesConfig queriesConfig
AdaptersConfig adaptersConfig
Specifies the adapter to be used when analyzing a document.
String jobId
The identifier for the document text detection job. Use JobId to identify the job in a subsequent
call to GetDocumentAnalysis. A JobId value is only valid for 7 days.
DocumentLocation documentLocation
The location of the document to be processed.
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. For more
information, see Calling Amazon Textract
Asynchronous Operations.
String jobTag
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic.
For example, you can use JobTag to identify the type of document that the completion notification
corresponds to (such as a tax form or a receipt).
NotificationChannel notificationChannel
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
OutputConfig outputConfig
Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.
String kMSKeyId
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.
String jobId
The identifier of the text detection job for the document. Use JobId to identify the job in a
subsequent call to GetDocumentTextDetection. A JobId value is only valid for 7 days.
DocumentLocation documentLocation
The location of the document to be processed.
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. For more
information, see Calling Amazon Textract
Asynchronous Operations
String jobTag
An identifier you specify that's included in the completion notification published to the Amazon SNS topic. For
example, you can use JobTag to identify the type of document that the completion notification
corresponds to (such as a tax form or a receipt).
NotificationChannel notificationChannel
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
OutputConfig outputConfig
Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results
internally to be accessed by the GetExpenseAnalysis operation.
String kMSKeyId
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.
String jobId
A unique identifier for the text detection job. The JobId is returned from
StartExpenseAnalysis. A JobId value is only valid for 7 days.
DocumentLocation documentLocation
String clientRequestToken
The idempotent token that you use to identify the start request. If you use the same token with multiple
StartLendingAnalysis requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidentally started more than once. For more
information, see Calling Amazon Textract
Asynchronous Operations.
String jobTag
An identifier that you specify to be included in the completion notification published to the Amazon SNS topic.
For example, you can use JobTag to identify the type of document that the completion notification
corresponds to (such as a tax form or a receipt).
NotificationChannel notificationChannel
OutputConfig outputConfig
String kMSKeyId
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side, using SSE-S3.
String jobId
A unique identifier for the lending or text-detection job. The JobId is returned from
StartLendingAnalysis. A JobId value is only valid for 7 days.
Integer page
The page where a signature was expected but not found.
String adapterId
A string containing a unique ID for the adapter that will be updated.
String description
The new description to be applied to the adapter.
String adapterName
The new name to be applied to the adapter.
String autoUpdate
The new auto-update status to be applied to the adapter.
String adapterId
A string containing a unique ID for the adapter that has been updated.
String adapterName
A string containing the name of the adapter that has been updated.
Date creationTime
An object specifying the creation time of the the adapter that has been updated.
String description
A string containing the description of the adapter that has been updated.
List<E> featureTypes
List of the targeted feature types for the updated adapter.
String autoUpdate
The auto-update status of the adapter that has been updated.
Copyright © 2025. All rights reserved.