You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) \n of an authorized user or IAM role to perform the operation.
", "smithy.api#error": "client" } }, "com.amazonaws.textract#AnalyzeDocument": { "type": "operation", "input": { "target": "com.amazonaws.textract#AnalyzeDocumentRequest" }, "output": { "target": "com.amazonaws.textract#AnalyzeDocumentResponse" }, "errors": [ { "target": "com.amazonaws.textract#AccessDeniedException" }, { "target": "com.amazonaws.textract#BadDocumentException" }, { "target": "com.amazonaws.textract#DocumentTooLargeException" }, { "target": "com.amazonaws.textract#HumanLoopQuotaExceededException" }, { "target": "com.amazonaws.textract#InternalServerError" }, { "target": "com.amazonaws.textract#InvalidParameterException" }, { "target": "com.amazonaws.textract#InvalidS3ObjectException" }, { "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" }, { "target": "com.amazonaws.textract#ThrottlingException" }, { "target": "com.amazonaws.textract#UnsupportedDocumentException" } ], "traits": { "smithy.api#documentation": "Analyzes an input document for relationships between detected items.
\nThe types of information returned are as follows:
\nForm data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY\n Block object and a VALUE Block object. For example,\n Name: Ana Silva Carolina contains a key and value.\n Name: is the key. Ana Silva Carolina is\n the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL\n Block object is returned for each cell in a table.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.\n All lines and words that are detected in the document are returned (including text that doesn't have a\n relationship with the value of FeatureTypes).
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT Block object contains information about a selection element,\n including the selection status.
You can choose which type of analysis to perform by specifying the FeatureTypes list. \n
The output is returned in a list of Block objects.
\n AnalyzeDocument is a synchronous operation. To analyze documents \n asynchronously, use StartDocumentAnalysis.
For more information, see Document Text Analysis.
" } }, "com.amazonaws.textract#AnalyzeDocumentRequest": { "type": "structure", "members": { "Document": { "target": "com.amazonaws.textract#Document", "traits": { "smithy.api#documentation": "The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI\n to call Amazon Textract operations, you can't pass image bytes. The document must be an image \n in JPEG or PNG format.
\nIf you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode\n image bytes that are passed using the Bytes field.
A list of the types of analysis to perform. Add TABLES to the list to return information\n about the tables that are detected in the input document. Add FORMS to return detected form data. \n To perform both types of analysis, add TABLES and FORMS to\n FeatureTypes. All lines and words detected in the document are included in\n the response (including text that isn't related to the value of FeatureTypes).
Sets the configuration for the human in the loop workflow for analyzing documents.
" } } } }, "com.amazonaws.textract#AnalyzeDocumentResponse": { "type": "structure", "members": { "DocumentMetadata": { "target": "com.amazonaws.textract#DocumentMetadata", "traits": { "smithy.api#documentation": "Metadata about the analyzed document. An example is the number of pages.
" } }, "Blocks": { "target": "com.amazonaws.textract#BlockList", "traits": { "smithy.api#documentation": "The items that are detected and analyzed by AnalyzeDocument.
Shows the results of the human in the loop evaluation.
" } }, "AnalyzeDocumentModelVersion": { "target": "com.amazonaws.textract#String", "traits": { "smithy.api#documentation": "The version of the model used to analyze the document.
" } } } }, "com.amazonaws.textract#BadDocumentException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.textract#String" }, "Code": { "target": "com.amazonaws.textract#String" } }, "traits": { "smithy.api#documentation": "Amazon Textract isn't able to read the document. For more information on the document\n limits in Amazon Textract, see limits.
", "smithy.api#error": "client" } }, "com.amazonaws.textract#Block": { "type": "structure", "members": { "BlockType": { "target": "com.amazonaws.textract#BlockType", "traits": { "smithy.api#documentation": "The type of text item that's recognized. In operations for text detection, the following\n types are returned:
\n\n PAGE - Contains a list of the LINE Block objects\n that are detected on a document page.
\n WORD - A word detected on a document page. A word is one or\n more ISO basic Latin script characters that aren't separated by spaces.
\n\n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.
\nIn text analysis operations, the following types are returned:
\n\n PAGE - Contains a list of child Block objects\n that are detected on a document page.
\n KEY_VALUE_SET - Stores the KEY and VALUE Block\n objects for linked text that's detected on a document page. Use the\n EntityType field to determine if a KEY_VALUE_SET object is a KEY\n Block object or a VALUE Block object.
\n WORD - A word that's detected on a document page. A word is\n one or more ISO basic Latin script characters that aren't separated by spaces.
\n\n LINE - A string of tab-delimited, contiguous words that are\n detected on a document page.
\n\n TABLE - A table that's detected on a document page. A table\n is grid-based information with two or more rows or columns, with a cell span of one\n row and one column each.
\n\n CELL - A cell within a detected table. The cell is the parent\n of the block that contains the text in the cell.
\n\n SELECTION_ELEMENT - A selection element such as an option\n button (radio button) or a check box that's detected on a document page. Use the\n value of SelectionStatus to determine the status of the selection\n element.
The confidence score that Amazon Textract has in the accuracy of the recognized text and\n the accuracy of the geometry points around the recognized text.
" } }, "Text": { "target": "com.amazonaws.textract#String", "traits": { "smithy.api#documentation": "The word or line of text that's recognized by Amazon Textract.
" } }, "TextType": { "target": "com.amazonaws.textract#TextType", "traits": { "smithy.api#documentation": "The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
" } }, "RowIndex": { "target": "com.amazonaws.textract#UInteger", "traits": { "smithy.api#documentation": "The row in which a table cell is located. The first row position is 1.\n RowIndex isn't returned by DetectDocumentText and\n GetDocumentTextDetection.
The column in which a table cell appears. The first column position is 1.\n ColumnIndex isn't returned by DetectDocumentText and\n GetDocumentTextDetection.
The number of rows that a table cell spans. Currently this value is always 1, even\n if the number of rows spanned is greater than 1. RowSpan isn't returned by\n DetectDocumentText and GetDocumentTextDetection.
The number of columns that a table cell spans. Currently this value is always 1, even\n if the number of columns spanned is greater than 1. ColumnSpan isn't returned by\n DetectDocumentText and GetDocumentTextDetection.
The location of the recognized text on the image. It includes an axis-aligned, coarse\n bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial\n information.
" } }, "Id": { "target": "com.amazonaws.textract#NonEmptyString", "traits": { "smithy.api#documentation": "The identifier for the recognized text. The identifier is only unique for a single\n operation.
" } }, "Relationships": { "target": "com.amazonaws.textract#RelationshipList", "traits": { "smithy.api#documentation": "A list of child blocks of the current block. For example, a LINE object has child blocks\n for each WORD block that's part of the line of text. There aren't Relationship objects in\n the list for relationships that don't exist, such as when the current block has no child\n blocks. The list size can be the following:
\n0 - The block has no child blocks.
\n1 - The block has child blocks.
\nThe type of entity. The following can be returned:
\n\n KEY - An identifier for a field on the document.
\n\n VALUE - The field text.
\n\n EntityTypes isn't returned by DetectDocumentText and\n GetDocumentTextDetection.
The selection status of a selection element, such as an option button or check box.
" } }, "Page": { "target": "com.amazonaws.textract#UInteger", "traits": { "smithy.api#documentation": "The page on which a block was detected. Page is returned by asynchronous\n operations. Page values greater than 1 are only returned for multipage documents that are\n in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is\n considered to be a single-page document. The value of Page is always 1.\n Synchronous operations don't return Page because every input document is\n considered to be a single-page document.
A Block represents items that are recognized in a document within a group\n of pixels close to each other. The information returned in a Block object\n depends on the type of operation. In text detection for documents (for example DetectDocumentText), you get information about the detected words and lines\n of text. In text analysis (for example AnalyzeDocument), you can also get\n information about the fields, tables, and selection elements that are detected in the\n document.
An array of Block objects is returned by both synchronous and asynchronous\n operations. In synchronous operations, such as DetectDocumentText, the\n array of Block objects is the entire set of results. In asynchronous\n operations, such as GetDocumentAnalysis, the array is returned over one\n or more responses.
For more information, see How Amazon Textract Works.
" } }, "com.amazonaws.textract#BlockList": { "type": "list", "member": { "target": "com.amazonaws.textract#Block" } }, "com.amazonaws.textract#BlockType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "KEY_VALUE_SET", "name": "KEY_VALUE_SET" }, { "value": "PAGE", "name": "PAGE" }, { "value": "LINE", "name": "LINE" }, { "value": "WORD", "name": "WORD" }, { "value": "TABLE", "name": "TABLE" }, { "value": "CELL", "name": "CELL" }, { "value": "SELECTION_ELEMENT", "name": "SELECTION_ELEMENT" } ] } }, "com.amazonaws.textract#BoundingBox": { "type": "structure", "members": { "Width": { "target": "com.amazonaws.textract#Float", "traits": { "smithy.api#documentation": "The width of the bounding box as a ratio of the overall document page\n width.
" } }, "Height": { "target": "com.amazonaws.textract#Float", "traits": { "smithy.api#documentation": "The height of the bounding box as a ratio of the overall document page\n height.
" } }, "Left": { "target": "com.amazonaws.textract#Float", "traits": { "smithy.api#documentation": "The left coordinate of the bounding box as a ratio of overall document page\n width.
" } }, "Top": { "target": "com.amazonaws.textract#Float", "traits": { "smithy.api#documentation": "The top coordinate of the bounding box as a ratio of overall document page\n height.
" } } }, "traits": { "smithy.api#documentation": "The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a\n document page. The left (x-coordinate) and top (y-coordinate) are\n coordinates that represent the top and left sides of the bounding box. Note that the\n upper-left corner of the image is the origin (0,0).
The top and left values returned are ratios of the overall\n document page size. For example, if the input image is 700 x 200 pixels, and the top-left\n coordinate of the bounding box is 350 x 50 pixels, the API returns a left\n 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\n bounding box as a ratio of the overall document page dimension. For example, if the\n document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width\n returned is 0.1.
Detects text in the input document. Amazon Textract can detect lines of text and the\n words that make up a line of text. The input document must be an image in JPEG or PNG\n format. DetectDocumentText returns the detected text in an array of Block objects.
Each document page has as an associated Block of type PAGE. Each PAGE Block object\n is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is\n a parent for each word that makes up the line. Words are represented by Block objects of type WORD.
\n DetectDocumentText is a synchronous operation. To analyze documents \n asynchronously, use StartDocumentTextDetection.
For more information, see Document Text Detection.
" } }, "com.amazonaws.textract#DetectDocumentTextRequest": { "type": "structure", "members": { "Document": { "target": "com.amazonaws.textract#Document", "traits": { "smithy.api#documentation": "The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI\n to call Amazon Textract operations, you can't pass image bytes. The document must be an image \n in JPEG or PNG format.
\nIf you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode\n image bytes that are passed using the Bytes field.
Metadata about the document. It contains the number of pages that are detected in the\n document.
" } }, "Blocks": { "target": "com.amazonaws.textract#BlockList", "traits": { "smithy.api#documentation": "An array of Block objects that contain the text that's detected in the\n document.
A blob of base64-encoded document bytes. The maximum size of a document that's provided\n in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.
\nIf you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode\n image bytes passed using the Bytes field.
Identifies an S3 object as the document source. The maximum size of a document that's\n stored in an S3 bucket is 5 MB.
" } } }, "traits": { "smithy.api#documentation": "The input document, either as bytes or as an S3 object.
\nYou pass image bytes to an Amazon Textract API operation by using the Bytes\n property. For example, you would use the Bytes property to pass a document\n loaded from a local file system. Image bytes passed by using the Bytes\n property must be base64 encoded. Your code might not need to encode document file bytes if\n 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\n S3Object property. Documents stored in an S3 bucket don't need to be base64\n encoded.
The AWS Region for the S3 bucket that contains the S3 object must match the AWS\n Region that you use for Amazon Textract operations.
\nIf you use the AWS CLI to call Amazon Textract operations, passing image bytes using\n the Bytes property isn't supported. You must first upload the document to an Amazon S3\n bucket, and then call the operation using the S3Object property.
\n \nFor Amazon Textract to process an S3 object, the user must have permission\n to access the S3 object.
" } }, "com.amazonaws.textract#DocumentLocation": { "type": "structure", "members": { "S3Object": { "target": "com.amazonaws.textract#S3Object", "traits": { "smithy.api#documentation": "The Amazon S3 bucket that contains the input document.
" } } }, "traits": { "smithy.api#documentation": "The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous\n operations such as StartDocumentTextDetection.
\nThe input document can be an image file in JPEG or PNG format. It can also be a file in\n PDF format.
" } }, "com.amazonaws.textract#DocumentMetadata": { "type": "structure", "members": { "Pages": { "target": "com.amazonaws.textract#UInteger", "traits": { "smithy.api#documentation": "The number of pages that are detected in the document.
" } } }, "traits": { "smithy.api#documentation": "Information about the input document.
" } }, "com.amazonaws.textract#DocumentTooLargeException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.textract#String" }, "Code": { "target": "com.amazonaws.textract#String" } }, "traits": { "smithy.api#documentation": "The document can't be processed because it's too large. The maximum document size for\n synchronous operations 10 MB. The maximum document size for asynchronous operations is 500\n MB for PDF files.
", "smithy.api#error": "client" } }, "com.amazonaws.textract#EntityType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "KEY", "name": "KEY" }, { "value": "VALUE", "name": "VALUE" } ] } }, "com.amazonaws.textract#EntityTypes": { "type": "list", "member": { "target": "com.amazonaws.textract#EntityType" } }, "com.amazonaws.textract#ErrorCode": { "type": "string" }, "com.amazonaws.textract#FeatureType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TABLES", "name": "TABLES" }, { "value": "FORMS", "name": "FORMS" } ] } }, "com.amazonaws.textract#FeatureTypes": { "type": "list", "member": { "target": "com.amazonaws.textract#FeatureType" } }, "com.amazonaws.textract#Float": { "type": "float" }, "com.amazonaws.textract#FlowDefinitionArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.textract#Geometry": { "type": "structure", "members": { "BoundingBox": { "target": "com.amazonaws.textract#BoundingBox", "traits": { "smithy.api#documentation": "An axis-aligned coarse representation of the location of the recognized item on the\n document page.
" } }, "Polygon": { "target": "com.amazonaws.textract#Polygon", "traits": { "smithy.api#documentation": "Within the bounding box, a fine-grained polygon around the recognized item.
" } } }, "traits": { "smithy.api#documentation": "Information about where the following items are located on a document page: detected\n page, text, key-value pairs, tables, table cells, and selection elements.
" } }, "com.amazonaws.textract#GetDocumentAnalysis": { "type": "operation", "input": { "target": "com.amazonaws.textract#GetDocumentAnalysisRequest" }, "output": { "target": "com.amazonaws.textract#GetDocumentAnalysisResponse" }, "errors": [ { "target": "com.amazonaws.textract#AccessDeniedException" }, { "target": "com.amazonaws.textract#InternalServerError" }, { "target": "com.amazonaws.textract#InvalidJobIdException" }, { "target": "com.amazonaws.textract#InvalidParameterException" }, { "target": "com.amazonaws.textract#InvalidS3ObjectException" }, { "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" }, { "target": "com.amazonaws.textract#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
\nYou start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier\n (JobId). When the text analysis operation finishes, Amazon Textract publishes a\n completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to\n StartDocumentAnalysis. To get the results of the text-detection operation,\n first check that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetDocumentAnalysis, and pass the job identifier\n (JobId) from the initial call to StartDocumentAnalysis.
\n GetDocumentAnalysis returns an array of Block objects. The following\n types of information are returned:
Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY\n Block object and a VALUE Block object. For example,\n Name: Ana Silva Carolina contains a key and value.\n Name: is the key. Ana Silva Carolina is\n the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL\n Block object is returned for each cell in a table.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.\n All lines and words that are detected in the document are returned (including text that doesn't have a\n relationship with the value of the StartDocumentAnalysis \n FeatureTypes input parameter).
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT Block object contains information about a selection element,\n including the selection status.
Use the MaxResults parameter to limit the number of blocks that are\n returned. If there are more results than specified in MaxResults, the value of\n NextToken in the operation response contains a pagination token for getting\n the next set of results. To get the next page of results, call\n GetDocumentAnalysis, and populate the NextToken request\n parameter with the token value that's returned from the previous call to\n GetDocumentAnalysis.
For more information, see Document Text Analysis.
" } }, "com.amazonaws.textract#GetDocumentAnalysisRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.textract#JobId", "traits": { "smithy.api#documentation": "A unique identifier for the text-detection job. The JobId is returned from\n StartDocumentAnalysis. A JobId value is only valid for 7 days.
The maximum number of results to return per paginated call. The largest value that you\n can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results\n is returned. The default value is 1,000.
" } }, "NextToken": { "target": "com.amazonaws.textract#PaginationToken", "traits": { "smithy.api#documentation": "If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of blocks.
" } } } }, "com.amazonaws.textract#GetDocumentAnalysisResponse": { "type": "structure", "members": { "DocumentMetadata": { "target": "com.amazonaws.textract#DocumentMetadata", "traits": { "smithy.api#documentation": "Information about a document that Amazon Textract processed. DocumentMetadata is\n returned in every page of paginated responses from an Amazon Textract video operation.
The current status of the text detection job.
" } }, "NextToken": { "target": "com.amazonaws.textract#PaginationToken", "traits": { "smithy.api#documentation": "If the response is truncated, Amazon Textract returns this token. You can use this token in\n the subsequent request to retrieve the next set of text detection results.
" } }, "Blocks": { "target": "com.amazonaws.textract#BlockList", "traits": { "smithy.api#documentation": "The results of the text-analysis operation.
" } }, "Warnings": { "target": "com.amazonaws.textract#Warnings", "traits": { "smithy.api#documentation": "A list of warnings that occurred during the document-analysis operation.
" } }, "StatusMessage": { "target": "com.amazonaws.textract#StatusMessage", "traits": { "smithy.api#documentation": "Returns if the detection job could not be completed. Contains explanation for what error occured.
" } }, "AnalyzeDocumentModelVersion": { "target": "com.amazonaws.textract#String", "traits": { "smithy.api#documentation": "" } } } }, "com.amazonaws.textract#GetDocumentTextDetection": { "type": "operation", "input": { "target": "com.amazonaws.textract#GetDocumentTextDetectionRequest" }, "output": { "target": "com.amazonaws.textract#GetDocumentTextDetectionResponse" }, "errors": [ { "target": "com.amazonaws.textract#AccessDeniedException" }, { "target": "com.amazonaws.textract#InternalServerError" }, { "target": "com.amazonaws.textract#InvalidJobIdException" }, { "target": "com.amazonaws.textract#InvalidParameterException" }, { "target": "com.amazonaws.textract#InvalidS3ObjectException" }, { "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" }, { "target": "com.amazonaws.textract#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Gets the results for an Amazon Textract asynchronous operation that detects text in a document. \n Amazon Textract can detect lines of text and the words that make up a line of text.
\nYou start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier\n (JobId). When the text detection operation finishes, Amazon Textract publishes a\n completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to\n StartDocumentTextDetection. To get the results of the text-detection\n operation, first check that the status value published to the Amazon SNS topic is\n SUCCEEDED. If so, call GetDocumentTextDetection, and pass the\n job identifier (JobId) from the initial call to\n StartDocumentTextDetection.
\n GetDocumentTextDetection returns an array of Block\n objects.
Each document page has as an associated Block of type PAGE. Each PAGE Block object\n is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is\n a parent for each word that makes up the line. Words are represented by Block objects of type WORD.
Use the MaxResults parameter to limit the number of blocks that are returned. If there\n are more results than specified in MaxResults, the value of\n NextToken in the operation response contains a pagination token for getting\n the next set of results. To get the next page of results, call\n GetDocumentTextDetection, and populate the NextToken request\n parameter with the token value that's returned from the previous call to\n GetDocumentTextDetection.
For more information, see Document Text Detection.
" } }, "com.amazonaws.textract#GetDocumentTextDetectionRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.textract#JobId", "traits": { "smithy.api#documentation": "A unique identifier for the text detection job. The JobId is returned from\n StartDocumentTextDetection. A JobId value is only valid for 7 days.
The maximum number of results to return per paginated call. The largest value you can\n specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is\n returned. The default value is 1,000.
" } }, "NextToken": { "target": "com.amazonaws.textract#PaginationToken", "traits": { "smithy.api#documentation": "If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination\n token in the response. You can use this pagination token to retrieve the next set of blocks.
" } } } }, "com.amazonaws.textract#GetDocumentTextDetectionResponse": { "type": "structure", "members": { "DocumentMetadata": { "target": "com.amazonaws.textract#DocumentMetadata", "traits": { "smithy.api#documentation": "Information about a document that Amazon Textract processed. DocumentMetadata is\n returned in every page of paginated responses from an Amazon Textract video operation.
The current status of the text detection job.
" } }, "NextToken": { "target": "com.amazonaws.textract#PaginationToken", "traits": { "smithy.api#documentation": "If the response is truncated, Amazon Textract returns this token. You can use this token in\n the subsequent request to retrieve the next set of text-detection results.
" } }, "Blocks": { "target": "com.amazonaws.textract#BlockList", "traits": { "smithy.api#documentation": "The results of the text-detection operation.
" } }, "Warnings": { "target": "com.amazonaws.textract#Warnings", "traits": { "smithy.api#documentation": "A list of warnings that occurred during the text-detection operation for the\n document.
" } }, "StatusMessage": { "target": "com.amazonaws.textract#StatusMessage", "traits": { "smithy.api#documentation": "Returns if the detection job could not be completed. Contains explanation for what error occured.
" } }, "DetectDocumentTextModelVersion": { "target": "com.amazonaws.textract#String", "traits": { "smithy.api#documentation": "" } } } }, "com.amazonaws.textract#HumanLoopActivationOutput": { "type": "structure", "members": { "HumanLoopArn": { "target": "com.amazonaws.textract#HumanLoopArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the HumanLoop created.
" } }, "HumanLoopActivationReasons": { "target": "com.amazonaws.textract#HumanLoopActivationReasons", "traits": { "smithy.api#documentation": "Shows if and why human review was needed.
" } }, "HumanLoopActivationConditionsEvaluationResults": { "target": "com.amazonaws.textract#SynthesizedJsonHumanLoopActivationConditionsEvaluationResults", "traits": { "smithy.api#documentation": "Shows the result of condition evaluations, including those conditions which activated a human review.
" } } }, "traits": { "smithy.api#documentation": "Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input \n did not trigger human review.
" } }, "com.amazonaws.textract#HumanLoopActivationReason": { "type": "string" }, "com.amazonaws.textract#HumanLoopActivationReasons": { "type": "list", "member": { "target": "com.amazonaws.textract#HumanLoopActivationReason" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.textract#HumanLoopArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.textract#HumanLoopConfig": { "type": "structure", "members": { "HumanLoopName": { "target": "com.amazonaws.textract#HumanLoopName", "traits": { "smithy.api#documentation": "The name of the human workflow used for this image. This should be kept unique within a region.
", "smithy.api#required": {} } }, "FlowDefinitionArn": { "target": "com.amazonaws.textract#FlowDefinitionArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow definition.
", "smithy.api#required": {} } }, "DataAttributes": { "target": "com.amazonaws.textract#HumanLoopDataAttributes", "traits": { "smithy.api#documentation": "Sets attributes of the input data.
" } } }, "traits": { "smithy.api#documentation": "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 \n of the image before review.
" } }, "com.amazonaws.textract#HumanLoopDataAttributes": { "type": "structure", "members": { "ContentClassifiers": { "target": "com.amazonaws.textract#ContentClassifiers", "traits": { "smithy.api#documentation": "Sets whether the input image is free of personally identifiable information or adult content.
" } } }, "traits": { "smithy.api#documentation": "Allows you to set attributes of the image. Currently, you can declare an image as free of\n personally identifiable information and adult content.
" } }, "com.amazonaws.textract#HumanLoopName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9])*" } }, "com.amazonaws.textract#HumanLoopQuotaExceededException": { "type": "structure", "members": { "ResourceType": { "target": "com.amazonaws.textract#String", "traits": { "smithy.api#documentation": "The resource type.
" } }, "QuotaCode": { "target": "com.amazonaws.textract#String", "traits": { "smithy.api#documentation": "The quota code.
" } }, "ServiceCode": { "target": "com.amazonaws.textract#String", "traits": { "smithy.api#documentation": "The service code.
" } }, "Message": { "target": "com.amazonaws.textract#String" }, "Code": { "target": "com.amazonaws.textract#String" } }, "traits": { "smithy.api#documentation": "Indicates you have exceeded the maximum number of active human in the loop workflows available
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.textract#IdList": { "type": "list", "member": { "target": "com.amazonaws.textract#NonEmptyString" } }, "com.amazonaws.textract#IdempotentParameterMismatchException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.textract#String" }, "Code": { "target": "com.amazonaws.textract#String" } }, "traits": { "smithy.api#documentation": "A ClientRequestToken input parameter was reused with an operation, but at\n least one of the other input parameters is different from the previous call to the\n operation.
Amazon Textract experienced a service issue. Try your call again.
", "smithy.api#error": "server" } }, "com.amazonaws.textract#InvalidJobIdException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.textract#String" }, "Code": { "target": "com.amazonaws.textract#String" } }, "traits": { "smithy.api#documentation": "An invalid job identifier was passed to GetDocumentAnalysis or to\n GetDocumentAnalysis.
", "smithy.api#error": "client" } }, "com.amazonaws.textract#InvalidKMSKeyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.textract#String" }, "Code": { "target": "com.amazonaws.textract#String" } }, "traits": { "smithy.api#documentation": "Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key\n was entered incorrectly.
", "smithy.api#error": "client" } }, "com.amazonaws.textract#InvalidParameterException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.textract#String" }, "Code": { "target": "com.amazonaws.textract#String" } }, "traits": { "smithy.api#documentation": "An input parameter violated a constraint. For example, in synchronous operations, \n an InvalidParameterException exception occurs\n when neither of the S3Object or Bytes values are supplied in the Document\n request parameter.\n Validate your parameter before calling the API operation again.
Amazon Textract is unable to access the S3 object that's specified in the request.\n for more information, Configure Access to Amazon S3\n For troubleshooting information, see Troubleshooting Amazon S3\n
", "smithy.api#error": "client" } }, "com.amazonaws.textract#JobId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" } }, "com.amazonaws.textract#JobStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "SUCCEEDED", "name": "SUCCEEDED" }, { "value": "FAILED", "name": "FAILED" }, { "value": "PARTIAL_SUCCESS", "name": "PARTIAL_SUCCESS" } ] } }, "com.amazonaws.textract#JobTag": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "[a-zA-Z0-9_.\\-:]+" } }, "com.amazonaws.textract#KMSKeyId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$" } }, "com.amazonaws.textract#LimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.textract#String" }, "Code": { "target": "com.amazonaws.textract#String" } }, "traits": { "smithy.api#documentation": "An Amazon Textract service limit was exceeded. For example, if you start too many\n asynchronous jobs concurrently, calls to start operations\n (StartDocumentTextDetection, for example) raise a LimitExceededException\n exception (HTTP status code: 400) until the number of concurrently running jobs is below\n the Amazon Textract service limit.
The Amazon SNS topic that Amazon Textract posts the completion status to.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.textract#RoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of\n an asynchronous document operation, such as StartDocumentTextDetection.
" } }, "com.amazonaws.textract#OutputConfig": { "type": "structure", "members": { "S3Bucket": { "target": "com.amazonaws.textract#S3Bucket", "traits": { "smithy.api#documentation": "The name of the bucket your output will go to.
", "smithy.api#required": {} } }, "S3Prefix": { "target": "com.amazonaws.textract#S3ObjectName", "traits": { "smithy.api#documentation": "The prefix of the object key that the output will be saved to. When \n not enabled, the prefix will be “textract_output\".
" } } }, "traits": { "smithy.api#documentation": "Sets whether or not your output will go to a user created bucket. \n Used to set the name of the bucket, and the prefix on the output \n file.
" } }, "com.amazonaws.textract#Pages": { "type": "list", "member": { "target": "com.amazonaws.textract#UInteger" } }, "com.amazonaws.textract#PaginationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.textract#Percent": { "type": "float", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.textract#Point": { "type": "structure", "members": { "X": { "target": "com.amazonaws.textract#Float", "traits": { "smithy.api#documentation": "The value of the X coordinate for a point on a Polygon.
The value of the Y coordinate for a point on a Polygon.
The X and Y coordinates of a point on a document page. The X and Y\n values that are returned are ratios of the overall document page size. For example, if the\n input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is\n at the (350,50) pixel coordinate on the document page.
\n \nAn array of Point objects, Polygon, is returned\n by DetectDocumentText. Polygon represents a fine-grained\n polygon around detected text. For more information, see Geometry in the Amazon Textract\n Developer Guide.
The number of requests exceeded your throughput limit. If you want to increase this limit, \n contact Amazon Textract.
", "smithy.api#error": "client" } }, "com.amazonaws.textract#Relationship": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.textract#RelationshipType", "traits": { "smithy.api#documentation": "The type of relationship that the blocks in the IDs array have with the current block.\n The relationship can be VALUE or CHILD. A relationship of type \n VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. \n A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines\n Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.
An\n array of IDs for related blocks. You can get the type of the relationship from the\n Type element.
Information about how blocks are related to each other. A Block object\n contains 0 or more Relation objects in a list, Relationships. For\n more information, see Block.
The Type element provides the type of the relationship for all blocks in\n the IDs array.
The name of the S3 bucket.
" } }, "Name": { "target": "com.amazonaws.textract#S3ObjectName", "traits": { "smithy.api#documentation": "The file name of the input document. Synchronous operations can use image files that are\n in JPEG or PNG format. Asynchronous operations also support PDF format files.
" } }, "Version": { "target": "com.amazonaws.textract#S3ObjectVersion", "traits": { "smithy.api#documentation": "If the bucket has versioning enabled, you can specify the object version.
" } } }, "traits": { "smithy.api#documentation": "The S3 bucket name and file name that identifies the document.
\nThe AWS Region for the S3 bucket that contains the document must match the Region that\n you use for Amazon Textract operations.
\n \nFor Amazon Textract to process a file in an S3 bucket, the user must have\n permission to access the S3 bucket and file.\n \n
" } }, "com.amazonaws.textract#S3ObjectName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.textract#S3ObjectVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.textract#SNSTopicArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 1024 }, "smithy.api#pattern": "(^arn:([a-z\\d-]+):sns:[a-zA-Z\\d-]{1,20}:\\w{12}:.+$)" } }, "com.amazonaws.textract#SelectionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SELECTED", "name": "SELECTED" }, { "value": "NOT_SELECTED", "name": "NOT_SELECTED" } ] } }, "com.amazonaws.textract#StartDocumentAnalysis": { "type": "operation", "input": { "target": "com.amazonaws.textract#StartDocumentAnalysisRequest" }, "output": { "target": "com.amazonaws.textract#StartDocumentAnalysisResponse" }, "errors": [ { "target": "com.amazonaws.textract#AccessDeniedException" }, { "target": "com.amazonaws.textract#BadDocumentException" }, { "target": "com.amazonaws.textract#DocumentTooLargeException" }, { "target": "com.amazonaws.textract#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.textract#InternalServerError" }, { "target": "com.amazonaws.textract#InvalidKMSKeyException" }, { "target": "com.amazonaws.textract#InvalidParameterException" }, { "target": "com.amazonaws.textract#InvalidS3ObjectException" }, { "target": "com.amazonaws.textract#LimitExceededException" }, { "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" }, { "target": "com.amazonaws.textract#ThrottlingException" }, { "target": "com.amazonaws.textract#UnsupportedDocumentException" } ], "traits": { "smithy.api#documentation": "Starts the asynchronous analysis of an input document for relationships between detected\n items such as key-value pairs, tables, and selection elements.
\n\n\n StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The\n documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name\n of the document.\n
\n StartDocumentAnalysis returns a job identifier\n (JobId) that you use to get the results of the operation. When text\n analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS)\n topic that you specify in NotificationChannel. To get the results of the text\n analysis operation, first check that the status value published to the Amazon SNS topic is\n SUCCEEDED. If so, call GetDocumentAnalysis, and pass\n the job identifier (JobId) from the initial call to\n StartDocumentAnalysis.
For more information, see Document Text Analysis.
" } }, "com.amazonaws.textract#StartDocumentAnalysisRequest": { "type": "structure", "members": { "DocumentLocation": { "target": "com.amazonaws.textract#DocumentLocation", "traits": { "smithy.api#documentation": "The location of the document to be processed.
", "smithy.api#required": {} } }, "FeatureTypes": { "target": "com.amazonaws.textract#FeatureTypes", "traits": { "smithy.api#documentation": "A list of the types of analysis to perform. Add TABLES to the list to return information\n about the tables that are detected in the input document. Add FORMS to return detected\n form data. To perform both types of analysis, add TABLES\n and FORMS to FeatureTypes. All lines and words detected in the document are\n included in the response (including text that isn't related to the value of\n FeatureTypes).
The idempotent token that you use to identify the start request. If you use the same\n token with multiple StartDocumentAnalysis requests, the same\n JobId is returned. Use ClientRequestToken to prevent the same\n job from being accidentally started more than once. For more information, see\n Calling Amazon Textract Asynchronous Operations.
An identifier that you specify that's included in the completion notification published\n to the Amazon SNS topic. For example, you can use JobTag to identify the type of\n document that the completion notification corresponds to (such as a tax form or a\n receipt).
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the\n operation to.
" } }, "OutputConfig": { "target": "com.amazonaws.textract#OutputConfig", "traits": { "smithy.api#documentation": "Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save\n the results internally to be accessed by the GetDocumentAnalysis operation.
" } }, "KMSKeyId": { "target": "com.amazonaws.textract#KMSKeyId", "traits": { "smithy.api#documentation": "The KMS key used to encrypt the inference results. This can be \n in either Key ID or Key Alias format. When a KMS key is provided, the \n KMS key will be used for server-side encryption of the objects in the \n customer bucket. When this parameter is not enabled, the result will \n be encrypted server side,using SSE-S3.
" } } } }, "com.amazonaws.textract#StartDocumentAnalysisResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.textract#JobId", "traits": { "smithy.api#documentation": "The identifier for the document text detection job. Use JobId to identify\n the job in a subsequent call to GetDocumentAnalysis. A JobId value \n is only valid for 7 days.
Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of\n text and the words that make up a line of text.
\n\n StartDocumentTextDetection can analyze text in documents that are in JPEG, PNG, and PDF format. The\n documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name\n of the document.\n
\n StartTextDetection returns a job identifier\n (JobId) that you use to get the results of the operation. When text\n detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS)\n topic that you specify in NotificationChannel. To get the results of the text\n detection operation, first check that the status value published to the Amazon SNS topic is\n SUCCEEDED. If so, call GetDocumentTextDetection, and\n pass the job identifier (JobId) from the initial call to\n StartDocumentTextDetection.
For more information, see Document Text Detection.
" } }, "com.amazonaws.textract#StartDocumentTextDetectionRequest": { "type": "structure", "members": { "DocumentLocation": { "target": "com.amazonaws.textract#DocumentLocation", "traits": { "smithy.api#documentation": "The location of the document to be processed.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.textract#ClientRequestToken", "traits": { "smithy.api#documentation": "The idempotent token that's used to identify the start request. If you use the same\n token with multiple StartDocumentTextDetection requests, the same\n JobId is returned. Use ClientRequestToken to prevent the same\n job from being accidentally started more than once. For more information, see\n Calling Amazon Textract Asynchronous Operations.
An identifier that you specify that's included in the completion notification published\n to the Amazon SNS topic. For example, you can use JobTag to identify the type of\n document that the completion notification corresponds to (such as a tax form or a\n receipt).
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the\n operation to.
" } }, "OutputConfig": { "target": "com.amazonaws.textract#OutputConfig", "traits": { "smithy.api#documentation": "Sets if the output will go to a customer defined bucket. By default Amazon Textract will\n save the results internally to be accessed with the GetDocumentTextDetection operation.
" } }, "KMSKeyId": { "target": "com.amazonaws.textract#KMSKeyId", "traits": { "smithy.api#documentation": "The KMS key used to encrypt the inference results. This can be \n in either Key ID or Key Alias format. When a KMS key is provided, the \n KMS key will be used for server-side encryption of the objects in the \n customer bucket. When this parameter is not enabled, the result will \n be encrypted server side,using SSE-S3.
" } } } }, "com.amazonaws.textract#StartDocumentTextDetectionResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.textract#JobId", "traits": { "smithy.api#documentation": "The identifier of the text detection job for the document. Use JobId to\n identify the job in a subsequent call to GetDocumentTextDetection.\n A JobId value is only valid for 7 days.
Amazon Textract detects and analyzes text in documents and converts it\n into machine-readable text. This is the API reference documentation for\n Amazon Textract.
", "smithy.api#title": "Amazon Textract" } }, "com.amazonaws.textract#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.textract#String" }, "Code": { "target": "com.amazonaws.textract#String" } }, "traits": { "smithy.api#documentation": "Amazon Textract is temporarily unable to process the request. Try your call again.
", "smithy.api#error": "server" } }, "com.amazonaws.textract#UInteger": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.textract#UnsupportedDocumentException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.textract#String" }, "Code": { "target": "com.amazonaws.textract#String" } }, "traits": { "smithy.api#documentation": "The format of the input document isn't supported. Documents for synchronous operations can be in\n PNG or JPEG format. Documents for asynchronous operations can also be in PDF format.
", "smithy.api#error": "client" } }, "com.amazonaws.textract#Warning": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.textract#ErrorCode", "traits": { "smithy.api#documentation": "The error code for the warning.
" } }, "Pages": { "target": "com.amazonaws.textract#Pages", "traits": { "smithy.api#documentation": "A list of the pages that the warning applies to.
" } } }, "traits": { "smithy.api#documentation": "A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document text detection (StartDocumentTextDetection).
" } }, "com.amazonaws.textract#Warnings": { "type": "list", "member": { "target": "com.amazonaws.textract#Warning" } } } }