# Actions The following actions are supported: + [AnalyzeDocument](API_AnalyzeDocument.md) + [AnalyzeExpense](API_AnalyzeExpense.md) + [AnalyzeID](API_AnalyzeID.md) + [CreateAdapter](API_CreateAdapter.md) + [CreateAdapterVersion](API_CreateAdapterVersion.md) + [DeleteAdapter](API_DeleteAdapter.md) + [DeleteAdapterVersion](API_DeleteAdapterVersion.md) + [DetectDocumentText](API_DetectDocumentText.md) + [GetAdapter](API_GetAdapter.md) + [GetAdapterVersion](API_GetAdapterVersion.md) + [GetDocumentAnalysis](API_GetDocumentAnalysis.md) + [GetDocumentTextDetection](API_GetDocumentTextDetection.md) + [GetExpenseAnalysis](API_GetExpenseAnalysis.md) + [GetLendingAnalysis](API_GetLendingAnalysis.md) + [GetLendingAnalysisSummary](API_GetLendingAnalysisSummary.md) + [ListAdapters](API_ListAdapters.md) + [ListAdapterVersions](API_ListAdapterVersions.md) + [ListTagsForResource](API_ListTagsForResource.md) + [StartDocumentAnalysis](API_StartDocumentAnalysis.md) + [StartDocumentTextDetection](API_StartDocumentTextDetection.md) + [StartExpenseAnalysis](API_StartExpenseAnalysis.md) + [StartLendingAnalysis](API_StartLendingAnalysis.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateAdapter](API_UpdateAdapter.md) # AnalyzeDocument Analyzes an input document for relationships between detected items. The types of information returned are as follows: + Form data (key-value pairs). The related information is returned in two [Block](API_Block.md) objects, each of type `KEY_VALUE_SET`: a KEY `Block` object and a VALUE `Block` object. For example, *Name: Ana Silva Carolina* contains a key and value. *Name:* is the key. *Ana Silva Carolina* is the value. + Table and table cell data. A TABLE `Block` object contains information about a detected table. A CELL `Block` object is returned for each cell in a table. + Lines and words of text. A LINE `Block` object contains one or more WORD `Block` objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of `FeatureTypes`). + Signatures. A SIGNATURE `Block` object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table. + Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object. + Query Result. A QUERY\$1RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score. Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION\$1ELEMENT `Block` object contains information about a selection element, including the selection status. You can choose which type of analysis to perform by specifying the `FeatureTypes` list. The output is returned in a list of `Block` objects. `AnalyzeDocument` is a synchronous operation. To analyze documents asynchronously, use [StartDocumentAnalysis](API_StartDocumentAnalysis.md). For more information, see [Document Text Analysis](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html). ## Request Syntax ``` { "AdaptersConfig": { "Adapters": [ { "AdapterId": "string", "Pages": [ "string" ], "Version": "string" } ] }, "Document": { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "FeatureTypes": [ "string" ], "HumanLoopConfig": { "DataAttributes": { "ContentClassifiers": [ "string" ] }, "FlowDefinitionArn": "string", "HumanLoopName": "string" }, "QueriesConfig": { "Queries": [ { "Alias": "string", "Pages": [ "string" ], "Text": "string" } ] } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AdaptersConfig](#API_AnalyzeDocument_RequestSyntax) ** Specifies the adapter to be used when analyzing a document. Type: [AdaptersConfig](API_AdaptersConfig.md) object Required: No ** [Document](#API_AnalyzeDocument_RequestSyntax) ** The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format. If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the `Bytes` field. Type: [Document](API_Document.md) object Required: Yes ** [FeatureTypes](#API_AnalyzeDocument_RequestSyntax) ** A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of `FeatureTypes`). Type: Array of strings Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT` Required: Yes ** [HumanLoopConfig](#API_AnalyzeDocument_RequestSyntax) ** Sets the configuration for the human in the loop workflow for analyzing documents. Type: [HumanLoopConfig](API_HumanLoopConfig.md) object Required: No ** [QueriesConfig](#API_AnalyzeDocument_RequestSyntax) ** Contains Queries and the alias for those Queries, as determined by the input. Type: [QueriesConfig](API_QueriesConfig.md) object Required: No ## Response Syntax ``` { "AnalyzeDocumentModelVersion": "string", "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Id": "string", "Page": number, "Query": { "Alias": "string", "Pages": [ "string" ], "Text": "string" }, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DocumentMetadata": { "Pages": number }, "HumanLoopActivationOutput": { "HumanLoopActivationConditionsEvaluationResults": "string", "HumanLoopActivationReasons": [ "string" ], "HumanLoopArn": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AnalyzeDocumentModelVersion](#API_AnalyzeDocument_ResponseSyntax) ** The version of the model used to analyze the document. Type: String ** [Blocks](#API_AnalyzeDocument_ResponseSyntax) ** The items that are detected and analyzed by `AnalyzeDocument`. Type: Array of [Block](API_Block.md) objects ** [DocumentMetadata](#API_AnalyzeDocument_ResponseSyntax) ** Metadata about the analyzed document. An example is the number of pages. Type: [DocumentMetadata](API_DocumentMetadata.md) object ** [HumanLoopActivationOutput](#API_AnalyzeDocument_ResponseSyntax) ** Shows the results of the human in the loop evaluation. Type: [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) object ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** BadDocumentException ** Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md). HTTP Status Code: 400 ** DocumentTooLargeException ** The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files. HTTP Status Code: 400 ** HumanLoopQuotaExceededException ** Indicates you have exceeded the maximum number of active human in the loop workflows available ** QuotaCode ** The quota code. ** ResourceType ** The resource type. ** ServiceCode ** The service code. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** UnsupportedDocumentException ** The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeDocument) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeDocument) # AnalyzeExpense `AnalyzeExpense` synchronously analyzes an input document for financially related relationships between text. Information is returned as `ExpenseDocuments` and seperated as follows: + `LineItemGroups`- A data set containing `LineItems` which store information about the lines of text, such as an item purchased and its price on a receipt. + `SummaryFields`- Contains all other information a receipt, such as header information or the vendors name. ## Request Syntax ``` { "Document": { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Document](#API_AnalyzeExpense_RequestSyntax) ** The input document, either as bytes or as an S3 object. You pass image bytes to an Amazon Textract API operation by using the `Bytes` property. For example, you would use the `Bytes` property to pass a document loaded from a local file system. Image bytes passed by using the `Bytes` property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations. You pass images stored in an S3 bucket to an Amazon Textract API operation by using the `S3Object` property. Documents stored in an S3 bucket don't need to be base64 encoded. The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations. If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property. For Amazon Textract to process an S3 object, the user must have permission to access the S3 object. Type: [Document](API_Document.md) object Required: Yes ## Response Syntax ``` { "DocumentMetadata": { "Pages": number }, "ExpenseDocuments": [ { "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Id": "string", "Page": number, "Query": { "Alias": "string", "Pages": [ "string" ], "Text": "string" }, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "ExpenseIndex": number, "LineItemGroups": [ { "LineItemGroupIndex": number, "LineItems": [ { "LineItemExpenseFields": [ { "Currency": { "Code": "string", "Confidence": number }, "GroupProperties": [ { "Id": "string", "Types": [ "string" ] } ], "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Text": "string" } } ] } ] } ], "SummaryFields": [ { "Currency": { "Code": "string", "Confidence": number }, "GroupProperties": [ { "Id": "string", "Types": [ "string" ] } ], "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Text": "string" } } ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DocumentMetadata](#API_AnalyzeExpense_ResponseSyntax) ** Information about the input document. Type: [DocumentMetadata](API_DocumentMetadata.md) object ** [ExpenseDocuments](#API_AnalyzeExpense_ResponseSyntax) ** The expenses detected by Amazon Textract. Type: Array of [ExpenseDocument](API_ExpenseDocument.md) objects ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** BadDocumentException ** Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md). HTTP Status Code: 400 ** DocumentTooLargeException ** The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** UnsupportedDocumentException ** The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeExpense) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeExpense) # AnalyzeID Analyzes identity documents for relevant information. This information is extracted and returned as `IdentityDocumentFields`, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, `AnalyzeID` doesn't return any Geometry data. ## Request Syntax ``` { "DocumentPages": [ { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DocumentPages](#API_AnalyzeID_RequestSyntax) ** The document being passed to AnalyzeID. Type: Array of [Document](API_Document.md) objects Array Members: Minimum number of 1 item. Maximum number of 2 items. Required: Yes ## Response Syntax ``` { "AnalyzeIDModelVersion": "string", "DocumentMetadata": { "Pages": number }, "IdentityDocuments": [ { "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Id": "string", "Page": number, "Query": { "Alias": "string", "Pages": [ "string" ], "Text": "string" }, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DocumentIndex": number, "IdentityDocumentFields": [ { "Type": { "Confidence": number, "NormalizedValue": { "Value": "string", "ValueType": "string" }, "Text": "string" }, "ValueDetection": { "Confidence": number, "NormalizedValue": { "Value": "string", "ValueType": "string" }, "Text": "string" } } ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AnalyzeIDModelVersion](#API_AnalyzeID_ResponseSyntax) ** The version of the AnalyzeIdentity API being used to process documents. Type: String ** [DocumentMetadata](#API_AnalyzeID_ResponseSyntax) ** Information about the input document. Type: [DocumentMetadata](API_DocumentMetadata.md) object ** [IdentityDocuments](#API_AnalyzeID_ResponseSyntax) ** The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document. Type: Array of [IdentityDocument](API_IdentityDocument.md) objects ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** BadDocumentException ** Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md). HTTP Status Code: 400 ** DocumentTooLargeException ** The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** UnsupportedDocumentException ** The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/AnalyzeID) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/AnalyzeID) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/AnalyzeID) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/AnalyzeID) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/AnalyzeID) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/AnalyzeID) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/AnalyzeID) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/AnalyzeID) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/AnalyzeID) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/AnalyzeID) # CreateAdapter Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is `QUERIES`. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED. ## Request Syntax ``` { "AdapterName": "string", "AutoUpdate": "string", "ClientRequestToken": "string", "Description": "string", "FeatureTypes": [ "string" ], "Tags": { "string" : "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AdapterName](#API_CreateAdapter_RequestSyntax) ** The name to be assigned to the adapter being created. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9-_]+` Required: Yes ** [AutoUpdate](#API_CreateAdapter_RequestSyntax) ** Controls whether or not the adapter should automatically update. Type: String Valid Values: `ENABLED | DISABLED` Required: No ** [ClientRequestToken](#API_CreateAdapter_RequestSyntax) ** Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` Required: No ** [Description](#API_CreateAdapter_RequestSyntax) ** The description to be assigned to the adapter being created. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$` Required: No ** [FeatureTypes](#API_CreateAdapter_RequestSyntax) ** The type of feature that the adapter is being trained on. Currrenly, supported feature types are: `QUERIES` Type: Array of strings Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT` Required: Yes ** [Tags](#API_CreateAdapter_RequestSyntax) ** A list of tags to be added to the adapter. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` Required: No ## Response Syntax ``` { "AdapterId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AdapterId](#API_CreateAdapter_ResponseSyntax) ** A string containing the unique ID for the adapter that has been created. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 400 ** IdempotentParameterMismatchException ** A `ClientRequestToken` input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** LimitExceededException ** An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (`StartDocumentTextDetection`, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Returned when a request cannot be completed as it would exceed a maximum service quota. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** ValidationException ** Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/CreateAdapter) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/CreateAdapter) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/CreateAdapter) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/CreateAdapter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/CreateAdapter) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/CreateAdapter) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/CreateAdapter) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/CreateAdapter) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/CreateAdapter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/CreateAdapter) # CreateAdapterVersion Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags. ## Request Syntax ``` { "AdapterId": "string", "ClientRequestToken": "string", "DatasetConfig": { "ManifestS3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "KMSKeyId": "string", "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" }, "Tags": { "string" : "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AdapterId](#API_CreateAdapterVersion_RequestSyntax) ** A string containing a unique ID for the adapter that will receive a new version. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. Required: Yes ** [ClientRequestToken](#API_CreateAdapterVersion_RequestSyntax) ** Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapterVersion requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` Required: No ** [DatasetConfig](#API_CreateAdapterVersion_RequestSyntax) ** Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the value. Type: [AdapterVersionDatasetConfig](API_AdapterVersionDatasetConfig.md) object Required: Yes ** [KMSKeyId](#API_CreateAdapterVersion_RequestSyntax) ** The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` Required: No ** [OutputConfig](#API_CreateAdapterVersion_RequestSyntax) ** Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file. `OutputConfig` is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With `OutputConfig` enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the `KMSKeyID` parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3. Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see [ Managing AI services opt-out policy. ](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) For more information on data privacy, see the [Data Privacy FAQ](https://aws.amazon.com/compliance/data-privacy-faq/). Type: [OutputConfig](API_OutputConfig.md) object Required: Yes ** [Tags](#API_CreateAdapterVersion_RequestSyntax) ** A set of tags (key-value pairs) that you want to attach to the adapter version. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` Required: No ## Response Syntax ``` { "AdapterId": "string", "AdapterVersion": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AdapterId](#API_CreateAdapterVersion_ResponseSyntax) ** A string containing the unique ID for the adapter that has received a new version. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. ** [AdapterVersion](#API_CreateAdapterVersion_ResponseSyntax) ** A string describing the new version of the adapter. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 400 ** IdempotentParameterMismatchException ** A `ClientRequestToken` input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidKMSKeyException ** Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. HTTP Status Code: 400 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** LimitExceededException ** An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (`StartDocumentTextDetection`, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ResourceNotFoundException ** Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Returned when a request cannot be completed as it would exceed a maximum service quota. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** ValidationException ** Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/CreateAdapterVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/CreateAdapterVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/CreateAdapterVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/CreateAdapterVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/CreateAdapterVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/CreateAdapterVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/CreateAdapterVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/CreateAdapterVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/CreateAdapterVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/CreateAdapterVersion) # DeleteAdapter Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID. ## Request Syntax ``` { "AdapterId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AdapterId](#API_DeleteAdapter_RequestSyntax) ** A string containing a unique ID for the adapter to be deleted. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ResourceNotFoundException ** Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** ValidationException ** Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/DeleteAdapter) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/DeleteAdapter) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DeleteAdapter) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/DeleteAdapter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DeleteAdapter) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/DeleteAdapter) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/DeleteAdapter) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DeleteAdapter) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DeleteAdapter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DeleteAdapter) # DeleteAdapterVersion Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion. ## Request Syntax ``` { "AdapterId": "string", "AdapterVersion": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AdapterId](#API_DeleteAdapterVersion_RequestSyntax) ** A string containing a unique ID for the adapter version that will be deleted. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. Required: Yes ** [AdapterVersion](#API_DeleteAdapterVersion_RequestSyntax) ** Specifies the adapter version to be deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ResourceNotFoundException ** Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** ValidationException ** Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/DeleteAdapterVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/DeleteAdapterVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DeleteAdapterVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/DeleteAdapterVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DeleteAdapterVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/DeleteAdapterVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/DeleteAdapterVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DeleteAdapterVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DeleteAdapterVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DeleteAdapterVersion) # DetectDocumentText Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. `DetectDocumentText` returns the detected text in an array of [Block](API_Block.md) objects. Each document page has as an associated `Block` of type PAGE. Each PAGE `Block` object is the parent of LINE `Block` objects that represent the lines of detected text on a page. A LINE `Block` object is a parent for each word that makes up the line. Words are represented by `Block` objects of type WORD. `DetectDocumentText` is a synchronous operation. To analyze documents asynchronously, use [StartDocumentTextDetection](API_StartDocumentTextDetection.md). For more information, see [Document Text Detection](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html). ## Request Syntax ``` { "Document": { "Bytes": blob, "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Document](#API_DetectDocumentText_RequestSyntax) ** The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format. If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the `Bytes` field. Type: [Document](API_Document.md) object Required: Yes ## Response Syntax ``` { "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Id": "string", "Page": number, "Query": { "Alias": "string", "Pages": [ "string" ], "Text": "string" }, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DetectDocumentTextModelVersion": "string", "DocumentMetadata": { "Pages": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Blocks](#API_DetectDocumentText_ResponseSyntax) ** An array of `Block` objects that contain the text that's detected in the document. Type: Array of [Block](API_Block.md) objects ** [DetectDocumentTextModelVersion](#API_DetectDocumentText_ResponseSyntax) ** Type: String ** [DocumentMetadata](#API_DetectDocumentText_ResponseSyntax) ** Metadata about the document. It contains the number of pages that are detected in the document. Type: [DocumentMetadata](API_DocumentMetadata.md) object ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** BadDocumentException ** Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md). HTTP Status Code: 400 ** DocumentTooLargeException ** The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** UnsupportedDocumentException ** The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/DetectDocumentText) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/DetectDocumentText) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/DetectDocumentText) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/DetectDocumentText) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/DetectDocumentText) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/DetectDocumentText) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/DetectDocumentText) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/DetectDocumentText) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/DetectDocumentText) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/DetectDocumentText) # GetAdapter Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes. ## Request Syntax ``` { "AdapterId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AdapterId](#API_GetAdapter_RequestSyntax) ** A string containing a unique ID for the adapter. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. Required: Yes ## Response Syntax ``` { "AdapterId": "string", "AdapterName": "string", "AutoUpdate": "string", "CreationTime": number, "Description": "string", "FeatureTypes": [ "string" ], "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AdapterId](#API_GetAdapter_ResponseSyntax) ** A string identifying the adapter that information has been retrieved for. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. ** [AdapterName](#API_GetAdapter_ResponseSyntax) ** The name of the requested adapter. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9-_]+` ** [AutoUpdate](#API_GetAdapter_ResponseSyntax) ** Binary value indicating if the adapter is being automatically updated or not. Type: String Valid Values: `ENABLED | DISABLED` ** [CreationTime](#API_GetAdapter_ResponseSyntax) ** The date and time the requested adapter was created at. Type: Timestamp ** [Description](#API_GetAdapter_ResponseSyntax) ** The description for the requested adapter. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$` ** [FeatureTypes](#API_GetAdapter_ResponseSyntax) ** List of the targeted feature types for the requested adapter. Type: Array of strings Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT` ** [Tags](#API_GetAdapter_ResponseSyntax) ** A set of tags (key-value pairs) associated with the adapter that has been retrieved. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ResourceNotFoundException ** Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** ValidationException ** Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetAdapter) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetAdapter) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetAdapter) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetAdapter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetAdapter) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetAdapter) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetAdapter) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetAdapter) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetAdapter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetAdapter) # GetAdapterVersion Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics. ## Request Syntax ``` { "AdapterId": "string", "AdapterVersion": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AdapterId](#API_GetAdapterVersion_RequestSyntax) ** A string specifying a unique ID for the adapter version you want to retrieve information for. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. Required: Yes ** [AdapterVersion](#API_GetAdapterVersion_RequestSyntax) ** A string specifying the adapter version you want to retrieve information for. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ## Response Syntax ``` { "AdapterId": "string", "AdapterVersion": "string", "CreationTime": number, "DatasetConfig": { "ManifestS3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "EvaluationMetrics": [ { "AdapterVersion": { "F1Score": number, "Precision": number, "Recall": number }, "Baseline": { "F1Score": number, "Precision": number, "Recall": number }, "FeatureType": "string" } ], "FeatureTypes": [ "string" ], "KMSKeyId": "string", "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" }, "Status": "string", "StatusMessage": "string", "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AdapterId](#API_GetAdapterVersion_ResponseSyntax) ** A string containing a unique ID for the adapter version being retrieved. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. ** [AdapterVersion](#API_GetAdapterVersion_ResponseSyntax) ** A string containing the adapter version that has been retrieved. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. ** [CreationTime](#API_GetAdapterVersion_ResponseSyntax) ** The time that the adapter version was created. Type: Timestamp ** [DatasetConfig](#API_GetAdapterVersion_ResponseSyntax) ** Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value. Type: [AdapterVersionDatasetConfig](API_AdapterVersionDatasetConfig.md) object ** [EvaluationMetrics](#API_GetAdapterVersion_ResponseSyntax) ** The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version. Type: Array of [AdapterVersionEvaluationMetric](API_AdapterVersionEvaluationMetric.md) objects ** [FeatureTypes](#API_GetAdapterVersion_ResponseSyntax) ** List of the targeted feature types for the requested adapter version. Type: Array of strings Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT` ** [KMSKeyId](#API_GetAdapterVersion_ResponseSyntax) ** The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` ** [OutputConfig](#API_GetAdapterVersion_ResponseSyntax) ** Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file. `OutputConfig` is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With `OutputConfig` enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the `KMSKeyID` parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3. Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see [ Managing AI services opt-out policy. ](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) For more information on data privacy, see the [Data Privacy FAQ](https://aws.amazon.com/compliance/data-privacy-faq/). Type: [OutputConfig](API_OutputConfig.md) object ** [Status](#API_GetAdapterVersion_ResponseSyntax) ** The status of the adapter version that has been requested. Type: String Valid Values: `ACTIVE | AT_RISK | DEPRECATED | CREATION_ERROR | CREATION_IN_PROGRESS` ** [StatusMessage](#API_GetAdapterVersion_ResponseSyntax) ** A message that describes the status of the requested adapter version. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$` ** [Tags](#API_GetAdapterVersion_ResponseSyntax) ** A set of tags (key-value pairs) that are associated with the adapter version. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ResourceNotFoundException ** Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** ValidationException ** Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetAdapterVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetAdapterVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetAdapterVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetAdapterVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetAdapterVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetAdapterVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetAdapterVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetAdapterVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetAdapterVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetAdapterVersion) # GetDocumentAnalysis Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document. You start asynchronous text analysis by calling [StartDocumentAnalysis](API_StartDocumentAnalysis.md), which returns a job identifier (`JobId`). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to `StartDocumentAnalysis`. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call `GetDocumentAnalysis`, and pass the job identifier (`JobId`) from the initial call to `StartDocumentAnalysis`. `GetDocumentAnalysis` returns an array of [Block](API_Block.md) objects. The following types of information are returned: + Form data (key-value pairs). The related information is returned in two [Block](API_Block.md) objects, each of type `KEY_VALUE_SET`: a KEY `Block` object and a VALUE `Block` object. For example, *Name: Ana Silva Carolina* contains a key and value. *Name:* is the key. *Ana Silva Carolina* is the value. + Table and table cell data. A TABLE `Block` object contains information about a detected table. A CELL `Block` object is returned for each cell in a table. + Lines and words of text. A LINE `Block` object contains one or more WORD `Block` objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the `StartDocumentAnalysis` `FeatureTypes` input parameter). + Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object. + Query Results. A QUERY\$1RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score. **Note** While processing a document with queries, look out for `INVALID_REQUEST_PARAMETERS` output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist. Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION\$1ELEMENT `Block` object contains information about a selection element, including the selection status. Use the `MaxResults` parameter to limit the number of blocks that are returned. If there are more results than specified in `MaxResults`, the value of `NextToken` in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call `GetDocumentAnalysis`, and populate the `NextToken` request parameter with the token value that's returned from the previous call to `GetDocumentAnalysis`. For more information, see [Document Text Analysis](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html). ## Request Syntax ``` { "JobId": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [JobId](#API_GetDocumentAnalysis_RequestSyntax) ** A unique identifier for the text-detection job. The `JobId` is returned from `StartDocumentAnalysis`. A `JobId` value is only valid for 7 days. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` Required: Yes ** [MaxResults](#API_GetDocumentAnalysis_RequestSyntax) ** The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000. Type: Integer Valid Range: Minimum value of 1. Required: No ** [NextToken](#API_GetDocumentAnalysis_RequestSyntax) ** If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `.*\S.*` Required: No ## Response Syntax ``` { "AnalyzeDocumentModelVersion": "string", "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Id": "string", "Page": number, "Query": { "Alias": "string", "Pages": [ "string" ], "Text": "string" }, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DocumentMetadata": { "Pages": number }, "JobStatus": "string", "NextToken": "string", "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AnalyzeDocumentModelVersion](#API_GetDocumentAnalysis_ResponseSyntax) ** Type: String ** [Blocks](#API_GetDocumentAnalysis_ResponseSyntax) ** The results of the text-analysis operation. Type: Array of [Block](API_Block.md) objects ** [DocumentMetadata](#API_GetDocumentAnalysis_ResponseSyntax) ** Information about a document that Amazon Textract processed. `DocumentMetadata` is returned in every page of paginated responses from an Amazon Textract video operation. Type: [DocumentMetadata](API_DocumentMetadata.md) object ** [JobStatus](#API_GetDocumentAnalysis_ResponseSyntax) ** The current status of the text detection job. Type: String Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` ** [NextToken](#API_GetDocumentAnalysis_ResponseSyntax) ** If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `.*\S.*` ** [StatusMessage](#API_GetDocumentAnalysis_ResponseSyntax) ** Returns if the detection job could not be completed. Contains explanation for what error occured. Type: String ** [Warnings](#API_GetDocumentAnalysis_ResponseSyntax) ** A list of warnings that occurred during the document-analysis operation. Type: Array of [Warning](API_Warning.md) objects ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidJobIdException ** An invalid job identifier was passed to an asynchronous analysis operation. HTTP Status Code: 400 ** InvalidKMSKeyException ** Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. HTTP Status Code: 400 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentAnalysis) # GetDocumentTextDetection Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text. You start asynchronous text detection by calling [StartDocumentTextDetection](API_StartDocumentTextDetection.md), which returns a job identifier (`JobId`). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to `StartDocumentTextDetection`. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call `GetDocumentTextDetection`, and pass the job identifier (`JobId`) from the initial call to `StartDocumentTextDetection`. `GetDocumentTextDetection` returns an array of [Block](API_Block.md) objects. Each document page has as an associated `Block` of type PAGE. Each PAGE `Block` object is the parent of LINE `Block` objects that represent the lines of detected text on a page. A LINE `Block` object is a parent for each word that makes up the line. Words are represented by `Block` objects of type WORD. Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in `MaxResults`, the value of `NextToken` in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call `GetDocumentTextDetection`, and populate the `NextToken` request parameter with the token value that's returned from the previous call to `GetDocumentTextDetection`. For more information, see [Document Text Detection](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html). ## Request Syntax ``` { "JobId": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [JobId](#API_GetDocumentTextDetection_RequestSyntax) ** A unique identifier for the text detection job. The `JobId` is returned from `StartDocumentTextDetection`. A `JobId` value is only valid for 7 days. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` Required: Yes ** [MaxResults](#API_GetDocumentTextDetection_RequestSyntax) ** The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000. Type: Integer Valid Range: Minimum value of 1. Required: No ** [NextToken](#API_GetDocumentTextDetection_RequestSyntax) ** If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `.*\S.*` Required: No ## Response Syntax ``` { "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Id": "string", "Page": number, "Query": { "Alias": "string", "Pages": [ "string" ], "Text": "string" }, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DetectDocumentTextModelVersion": "string", "DocumentMetadata": { "Pages": number }, "JobStatus": "string", "NextToken": "string", "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Blocks](#API_GetDocumentTextDetection_ResponseSyntax) ** The results of the text-detection operation. Type: Array of [Block](API_Block.md) objects ** [DetectDocumentTextModelVersion](#API_GetDocumentTextDetection_ResponseSyntax) ** Type: String ** [DocumentMetadata](#API_GetDocumentTextDetection_ResponseSyntax) ** Information about a document that Amazon Textract processed. `DocumentMetadata` is returned in every page of paginated responses from an Amazon Textract video operation. Type: [DocumentMetadata](API_DocumentMetadata.md) object ** [JobStatus](#API_GetDocumentTextDetection_ResponseSyntax) ** The current status of the text detection job. Type: String Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` ** [NextToken](#API_GetDocumentTextDetection_ResponseSyntax) ** If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `.*\S.*` ** [StatusMessage](#API_GetDocumentTextDetection_ResponseSyntax) ** Returns if the detection job could not be completed. Contains explanation for what error occured. Type: String ** [Warnings](#API_GetDocumentTextDetection_ResponseSyntax) ** A list of warnings that occurred during the text-detection operation for the document. Type: Array of [Warning](API_Warning.md) objects ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidJobIdException ** An invalid job identifier was passed to an asynchronous analysis operation. HTTP Status Code: 400 ** InvalidKMSKeyException ** Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. HTTP Status Code: 400 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetDocumentTextDetection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetDocumentTextDetection) # GetExpenseAnalysis Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts. You start asynchronous invoice/receipt analysis by calling [StartExpenseAnalysis](API_StartExpenseAnalysis.md), which returns a job identifier (`JobId`). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to `StartExpenseAnalysis`. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call `GetExpenseAnalysis`, and pass the job identifier (`JobId`) from the initial call to `StartExpenseAnalysis`. Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in `MaxResults`, the value of `NextToken` in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call `GetExpenseAnalysis`, and populate the `NextToken` request parameter with the token value that's returned from the previous call to `GetExpenseAnalysis`. For more information, see [Analyzing Invoices and Receipts](https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html). ## Request Syntax ``` { "JobId": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [JobId](#API_GetExpenseAnalysis_RequestSyntax) ** A unique identifier for the text detection job. The `JobId` is returned from `StartExpenseAnalysis`. A `JobId` value is only valid for 7 days. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` Required: Yes ** [MaxResults](#API_GetExpenseAnalysis_RequestSyntax) ** The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20. Type: Integer Valid Range: Minimum value of 1. Required: No ** [NextToken](#API_GetExpenseAnalysis_RequestSyntax) ** If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `.*\S.*` Required: No ## Response Syntax ``` { "AnalyzeExpenseModelVersion": "string", "DocumentMetadata": { "Pages": number }, "ExpenseDocuments": [ { "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Id": "string", "Page": number, "Query": { "Alias": "string", "Pages": [ "string" ], "Text": "string" }, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "ExpenseIndex": number, "LineItemGroups": [ { "LineItemGroupIndex": number, "LineItems": [ { "LineItemExpenseFields": [ { "Currency": { "Code": "string", "Confidence": number }, "GroupProperties": [ { "Id": "string", "Types": [ "string" ] } ], "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Text": "string" } } ] } ] } ], "SummaryFields": [ { "Currency": { "Code": "string", "Confidence": number }, "GroupProperties": [ { "Id": "string", "Types": [ "string" ] } ], "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Text": "string" } } ] } ], "JobStatus": "string", "NextToken": "string", "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AnalyzeExpenseModelVersion](#API_GetExpenseAnalysis_ResponseSyntax) ** The current model version of AnalyzeExpense. Type: String ** [DocumentMetadata](#API_GetExpenseAnalysis_ResponseSyntax) ** Information about a document that Amazon Textract processed. `DocumentMetadata` is returned in every page of paginated responses from an Amazon Textract operation. Type: [DocumentMetadata](API_DocumentMetadata.md) object ** [ExpenseDocuments](#API_GetExpenseAnalysis_ResponseSyntax) ** The expenses detected by Amazon Textract. Type: Array of [ExpenseDocument](API_ExpenseDocument.md) objects ** [JobStatus](#API_GetExpenseAnalysis_ResponseSyntax) ** The current status of the text detection job. Type: String Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` ** [NextToken](#API_GetExpenseAnalysis_ResponseSyntax) ** If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `.*\S.*` ** [StatusMessage](#API_GetExpenseAnalysis_ResponseSyntax) ** Returns if the detection job could not be completed. Contains explanation for what error occured. Type: String ** [Warnings](#API_GetExpenseAnalysis_ResponseSyntax) ** A list of warnings that occurred during the text-detection operation for the document. Type: Array of [Warning](API_Warning.md) objects ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidJobIdException ** An invalid job identifier was passed to an asynchronous analysis operation. HTTP Status Code: 400 ** InvalidKMSKeyException ** Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. HTTP Status Code: 400 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetExpenseAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetExpenseAnalysis) # GetLendingAnalysis Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document. You start asynchronous text analysis by calling `StartLendingAnalysis`, which returns a job identifier (`JobId`). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to `StartLendingAnalysis`. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass the job identifier (`JobId`) from the initial call to `StartLendingAnalysis`. ## Request Syntax ``` { "JobId": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [JobId](#API_GetLendingAnalysis_RequestSyntax) ** A unique identifier for the lending or text-detection job. The `JobId` is returned from `StartLendingAnalysis`. A `JobId` value is only valid for 7 days. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` Required: Yes ** [MaxResults](#API_GetLendingAnalysis_RequestSyntax) ** The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30. Type: Integer Valid Range: Minimum value of 1. Required: No ** [NextToken](#API_GetLendingAnalysis_RequestSyntax) ** If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `.*\S.*` Required: No ## Response Syntax ``` { "AnalyzeLendingModelVersion": "string", "DocumentMetadata": { "Pages": number }, "JobStatus": "string", "NextToken": "string", "Results": [ { "Extractions": [ { "ExpenseDocument": { "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Id": "string", "Page": number, "Query": { "Alias": "string", "Pages": [ "string" ], "Text": "string" }, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "ExpenseIndex": number, "LineItemGroups": [ { "LineItemGroupIndex": number, "LineItems": [ { "LineItemExpenseFields": [ { "Currency": { "Code": "string", "Confidence": number }, "GroupProperties": [ { "Id": "string", "Types": [ "string" ] } ], "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Text": "string" } } ] } ] } ], "SummaryFields": [ { "Currency": { "Code": "string", "Confidence": number }, "GroupProperties": [ { "Id": "string", "Types": [ "string" ] } ], "LabelDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Text": "string" }, "PageNumber": number, "Type": { "Confidence": number, "Text": "string" }, "ValueDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Text": "string" } } ] }, "IdentityDocument": { "Blocks": [ { "BlockType": "string", "ColumnIndex": number, "ColumnSpan": number, "Confidence": number, "EntityTypes": [ "string" ], "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "Id": "string", "Page": number, "Query": { "Alias": "string", "Pages": [ "string" ], "Text": "string" }, "Relationships": [ { "Ids": [ "string" ], "Type": "string" } ], "RowIndex": number, "RowSpan": number, "SelectionStatus": "string", "Text": "string", "TextType": "string" } ], "DocumentIndex": number, "IdentityDocumentFields": [ { "Type": { "Confidence": number, "NormalizedValue": { "Value": "string", "ValueType": "string" }, "Text": "string" }, "ValueDetection": { "Confidence": number, "NormalizedValue": { "Value": "string", "ValueType": "string" }, "Text": "string" } } ] }, "LendingDocument": { "LendingFields": [ { "KeyDetection": { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "SelectionStatus": "string", "Text": "string" }, "Type": "string", "ValueDetections": [ { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number }, "SelectionStatus": "string", "Text": "string" } ] } ], "SignatureDetections": [ { "Confidence": number, "Geometry": { "BoundingBox": { "Height": number, "Left": number, "Top": number, "Width": number }, "Polygon": [ { "X": number, "Y": number } ], "RotationAngle": number } } ] } } ], "Page": number, "PageClassification": { "PageNumber": [ { "Confidence": number, "Value": "string" } ], "PageType": [ { "Confidence": number, "Value": "string" } ] } } ], "StatusMessage": "string", "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AnalyzeLendingModelVersion](#API_GetLendingAnalysis_ResponseSyntax) ** The current model version of the Analyze Lending API. Type: String ** [DocumentMetadata](#API_GetLendingAnalysis_ResponseSyntax) ** Information about the input document. Type: [DocumentMetadata](API_DocumentMetadata.md) object ** [JobStatus](#API_GetLendingAnalysis_ResponseSyntax) ** The current status of the lending analysis job. Type: String Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` ** [NextToken](#API_GetLendingAnalysis_ResponseSyntax) ** If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of lending results. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `.*\S.*` ** [Results](#API_GetLendingAnalysis_ResponseSyntax) ** Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe. Type: Array of [LendingResult](API_LendingResult.md) objects ** [StatusMessage](#API_GetLendingAnalysis_ResponseSyntax) ** Returns if the lending analysis job could not be completed. Contains explanation for what error occurred. Type: String ** [Warnings](#API_GetLendingAnalysis_ResponseSyntax) ** A list of warnings that occurred during the lending analysis operation. Type: Array of [Warning](API_Warning.md) objects ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidJobIdException ** An invalid job identifier was passed to an asynchronous analysis operation. HTTP Status Code: 400 ** InvalidKMSKeyException ** Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. HTTP Status Code: 400 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetLendingAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetLendingAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetLendingAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetLendingAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetLendingAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetLendingAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetLendingAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetLendingAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetLendingAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetLendingAnalysis) # GetLendingAnalysisSummary Gets summarized results for the `StartLendingAnalysis` operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document. You start asynchronous text analysis by calling `StartLendingAnalysis`, which returns a job identifier (`JobId`). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to `StartLendingAnalysis`. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call `GetLendingAnalysisSummary`, and pass the job identifier (`JobId`) from the initial call to `StartLendingAnalysis`. ## Request Syntax ``` { "JobId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [JobId](#API_GetLendingAnalysisSummary_RequestSyntax) ** A unique identifier for the lending or text-detection job. The `JobId` is returned from StartLendingAnalysis. A `JobId` value is only valid for 7 days. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` Required: Yes ## Response Syntax ``` { "AnalyzeLendingModelVersion": "string", "DocumentMetadata": { "Pages": number }, "JobStatus": "string", "StatusMessage": "string", "Summary": { "DocumentGroups": [ { "DetectedSignatures": [ { "Page": number } ], "SplitDocuments": [ { "Index": number, "Pages": [ number ] } ], "Type": "string", "UndetectedSignatures": [ { "Page": number } ] } ], "UndetectedDocumentTypes": [ "string" ] }, "Warnings": [ { "ErrorCode": "string", "Pages": [ number ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AnalyzeLendingModelVersion](#API_GetLendingAnalysisSummary_ResponseSyntax) ** The current model version of the Analyze Lending API. Type: String ** [DocumentMetadata](#API_GetLendingAnalysisSummary_ResponseSyntax) ** Information about the input document. Type: [DocumentMetadata](API_DocumentMetadata.md) object ** [JobStatus](#API_GetLendingAnalysisSummary_ResponseSyntax) ** The current status of the lending analysis job. Type: String Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS` ** [StatusMessage](#API_GetLendingAnalysisSummary_ResponseSyntax) ** Returns if the lending analysis could not be completed. Contains explanation for what error occurred. Type: String ** [Summary](#API_GetLendingAnalysisSummary_ResponseSyntax) ** Contains summary information for documents grouped by type. Type: [LendingSummary](API_LendingSummary.md) object ** [Warnings](#API_GetLendingAnalysisSummary_ResponseSyntax) ** A list of warnings that occurred during the lending analysis operation. Type: Array of [Warning](API_Warning.md) objects ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidJobIdException ** An invalid job identifier was passed to an asynchronous analysis operation. HTTP Status Code: 400 ** InvalidKMSKeyException ** Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. HTTP Status Code: 400 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/GetLendingAnalysisSummary) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/GetLendingAnalysisSummary) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/GetLendingAnalysisSummary) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/GetLendingAnalysisSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/GetLendingAnalysisSummary) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/GetLendingAnalysisSummary) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/GetLendingAnalysisSummary) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/GetLendingAnalysisSummary) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/GetLendingAnalysisSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/GetLendingAnalysisSummary) # ListAdapters Lists all adapters that match the specified filtration criteria. ## Request Syntax ``` { "AfterCreationTime": number, "BeforeCreationTime": number, "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AfterCreationTime](#API_ListAdapters_RequestSyntax) ** Specifies the lower bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created after the specified creation time. Type: Timestamp Required: No ** [BeforeCreationTime](#API_ListAdapters_RequestSyntax) ** Specifies the upper bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created before the specified creation time. Type: Timestamp Required: No ** [MaxResults](#API_ListAdapters_RequestSyntax) ** The maximum number of results to return when listing adapters. Type: Integer Valid Range: Minimum value of 1. Required: No ** [NextToken](#API_ListAdapters_RequestSyntax) ** Identifies the next page of results to return when listing adapters. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `.*\S.*` Required: No ## Response Syntax ``` { "Adapters": [ { "AdapterId": "string", "AdapterName": "string", "CreationTime": number, "FeatureTypes": [ "string" ] } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Adapters](#API_ListAdapters_ResponseSyntax) ** A list of adapters that matches the filtering criteria specified when calling ListAdapters. Type: Array of [AdapterOverview](API_AdapterOverview.md) objects ** [NextToken](#API_ListAdapters_ResponseSyntax) ** Identifies the next page of results to return when listing adapters. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `.*\S.*` ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** ValidationException ** Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/ListAdapters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/ListAdapters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ListAdapters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/ListAdapters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ListAdapters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/ListAdapters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/ListAdapters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/ListAdapters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/ListAdapters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ListAdapters) # ListAdapterVersions List all version of an adapter that meet the specified filtration criteria. ## Request Syntax ``` { "AdapterId": "string", "AfterCreationTime": number, "BeforeCreationTime": number, "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AdapterId](#API_ListAdapterVersions_RequestSyntax) ** A string containing a unique ID for the adapter to match for when listing adapter versions. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. Required: No ** [AfterCreationTime](#API_ListAdapterVersions_RequestSyntax) ** Specifies the lower bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time. Type: Timestamp Required: No ** [BeforeCreationTime](#API_ListAdapterVersions_RequestSyntax) ** Specifies the upper bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time. Type: Timestamp Required: No ** [MaxResults](#API_ListAdapterVersions_RequestSyntax) ** The maximum number of results to return when listing adapter versions. Type: Integer Valid Range: Minimum value of 1. Required: No ** [NextToken](#API_ListAdapterVersions_RequestSyntax) ** Identifies the next page of results to return when listing adapter versions. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `.*\S.*` Required: No ## Response Syntax ``` { "AdapterVersions": [ { "AdapterId": "string", "AdapterVersion": "string", "CreationTime": number, "FeatureTypes": [ "string" ], "Status": "string", "StatusMessage": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AdapterVersions](#API_ListAdapterVersions_ResponseSyntax) ** Adapter versions that match the filtering criteria specified when calling ListAdapters. Type: Array of [AdapterVersionOverview](API_AdapterVersionOverview.md) objects ** [NextToken](#API_ListAdapterVersions_ResponseSyntax) ** Identifies the next page of results to return when listing adapter versions. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `.*\S.*` ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ResourceNotFoundException ** Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** ValidationException ** Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/ListAdapterVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/ListAdapterVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ListAdapterVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/ListAdapterVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ListAdapterVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/ListAdapterVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/ListAdapterVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/ListAdapterVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/ListAdapterVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ListAdapterVersions) # ListTagsForResource Lists all tags for an Amazon Textract resource. ## Request Syntax ``` { "ResourceARN": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) that specifies the resource to list tags for. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Required: Yes ## Response Syntax ``` { "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** A set of tags (key-value pairs) that are part of the requested resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ResourceNotFoundException ** Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** ValidationException ** Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/ListTagsForResource) # StartDocumentAnalysis Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements. `StartDocumentAnalysis` can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use [DocumentLocation](API_DocumentLocation.md) to specify the bucket name and file name of the document. `StartDocumentAnalysis` returns a job identifier (`JobId`) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in `NotificationChannel`. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call [GetDocumentAnalysis](API_GetDocumentAnalysis.md), and pass the job identifier (`JobId`) from the initial call to `StartDocumentAnalysis`. For more information, see [Document Text Analysis](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html). ## Request Syntax ``` { "AdaptersConfig": { "Adapters": [ { "AdapterId": "string", "Pages": [ "string" ], "Version": "string" } ] }, "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "FeatureTypes": [ "string" ], "JobTag": "string", "KMSKeyId": "string", "NotificationChannel": { "RoleArn": "string", "SNSTopicArn": "string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" }, "QueriesConfig": { "Queries": [ { "Alias": "string", "Pages": [ "string" ], "Text": "string" } ] } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AdaptersConfig](#API_StartDocumentAnalysis_RequestSyntax) ** Specifies the adapter to be used when analyzing a document. Type: [AdaptersConfig](API_AdaptersConfig.md) object Required: No ** [ClientRequestToken](#API_StartDocumentAnalysis_RequestSyntax) ** The idempotent token that you use to identify the start request. If you use the same token with multiple `StartDocumentAnalysis` requests, the same `JobId` is returned. Use `ClientRequestToken` to prevent the same job from being accidentally started more than once. For more information, see [Calling Amazon Textract Asynchronous Operations](https://docs.aws.amazon.com/textract/latest/dg/api-async.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` Required: No ** [DocumentLocation](#API_StartDocumentAnalysis_RequestSyntax) ** The location of the document to be processed. Type: [DocumentLocation](API_DocumentLocation.md) object Required: Yes ** [FeatureTypes](#API_StartDocumentAnalysis_RequestSyntax) ** A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to `FeatureTypes`. All lines and words detected in the document are included in the response (including text that isn't related to the value of `FeatureTypes`). Type: Array of strings Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT` Required: Yes ** [JobTag](#API_StartDocumentAnalysis_RequestSyntax) ** An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use `JobTag` to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt). Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9_.\-:]+` Required: No ** [KMSKeyId](#API_StartDocumentAnalysis_RequestSyntax) ** The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` Required: No ** [NotificationChannel](#API_StartDocumentAnalysis_RequestSyntax) ** The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to. Type: [NotificationChannel](API_NotificationChannel.md) object Required: No ** [OutputConfig](#API_StartDocumentAnalysis_RequestSyntax) ** Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation. Type: [OutputConfig](API_OutputConfig.md) object Required: No ** [QueriesConfig](#API_StartDocumentAnalysis_RequestSyntax) ** Type: [QueriesConfig](API_QueriesConfig.md) object Required: No ## Response Syntax ``` { "JobId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobId](#API_StartDocumentAnalysis_ResponseSyntax) ** The identifier for the document text detection job. Use `JobId` to identify the job in a subsequent call to `GetDocumentAnalysis`. A `JobId` value is only valid for 7 days. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** BadDocumentException ** Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md). HTTP Status Code: 400 ** DocumentTooLargeException ** The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files. HTTP Status Code: 400 ** IdempotentParameterMismatchException ** A `ClientRequestToken` input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidKMSKeyException ** Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. HTTP Status Code: 400 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** LimitExceededException ** An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (`StartDocumentTextDetection`, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** UnsupportedDocumentException ** The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentAnalysis) # StartDocumentTextDetection Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text. `StartDocumentTextDetection` can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use [DocumentLocation](API_DocumentLocation.md) to specify the bucket name and file name of the document. `StartDocumentTextDetection` returns a job identifier (`JobId`) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in `NotificationChannel`. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call [GetDocumentTextDetection](API_GetDocumentTextDetection.md), and pass the job identifier (`JobId`) from the initial call to `StartDocumentTextDetection`. For more information, see [Document Text Detection](https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html). ## Request Syntax ``` { "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "JobTag": "string", "KMSKeyId": "string", "NotificationChannel": { "RoleArn": "string", "SNSTopicArn": "string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ClientRequestToken](#API_StartDocumentTextDetection_RequestSyntax) ** The idempotent token that's used to identify the start request. If you use the same token with multiple `StartDocumentTextDetection` requests, the same `JobId` is returned. Use `ClientRequestToken` to prevent the same job from being accidentally started more than once. For more information, see [Calling Amazon Textract Asynchronous Operations](https://docs.aws.amazon.com/textract/latest/dg/api-async.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` Required: No ** [DocumentLocation](#API_StartDocumentTextDetection_RequestSyntax) ** The location of the document to be processed. Type: [DocumentLocation](API_DocumentLocation.md) object Required: Yes ** [JobTag](#API_StartDocumentTextDetection_RequestSyntax) ** An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use `JobTag` to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt). Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9_.\-:]+` Required: No ** [KMSKeyId](#API_StartDocumentTextDetection_RequestSyntax) ** The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` Required: No ** [NotificationChannel](#API_StartDocumentTextDetection_RequestSyntax) ** The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to. Type: [NotificationChannel](API_NotificationChannel.md) object Required: No ** [OutputConfig](#API_StartDocumentTextDetection_RequestSyntax) ** Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation. Type: [OutputConfig](API_OutputConfig.md) object Required: No ## Response Syntax ``` { "JobId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobId](#API_StartDocumentTextDetection_ResponseSyntax) ** The identifier of the text detection job for the document. Use `JobId` to identify the job in a subsequent call to `GetDocumentTextDetection`. A `JobId` value is only valid for 7 days. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** BadDocumentException ** Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md). HTTP Status Code: 400 ** DocumentTooLargeException ** The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files. HTTP Status Code: 400 ** IdempotentParameterMismatchException ** A `ClientRequestToken` input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidKMSKeyException ** Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. HTTP Status Code: 400 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** LimitExceededException ** An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (`StartDocumentTextDetection`, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** UnsupportedDocumentException ** The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartDocumentTextDetection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartDocumentTextDetection) # StartExpenseAnalysis Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names. `StartExpenseAnalysis` can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the [DocumentLocation](API_DocumentLocation.md) parameter to specify the name of your S3 bucket and the name of the document in that bucket. `StartExpenseAnalysis` returns a job identifier (`JobId`) that you will provide to `GetExpenseAnalysis` to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the `NotificationChannel`. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is `SUCCEEDED`. If so, call [GetExpenseAnalysis](API_GetExpenseAnalysis.md), and pass the job identifier (`JobId`) that was returned by your call to `StartExpenseAnalysis`. For more information, see [Analyzing Invoices and Receipts](https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html). ## Request Syntax ``` { "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "JobTag": "string", "KMSKeyId": "string", "NotificationChannel": { "RoleArn": "string", "SNSTopicArn": "string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ClientRequestToken](#API_StartExpenseAnalysis_RequestSyntax) ** The idempotent token that's used to identify the start request. If you use the same token with multiple `StartDocumentTextDetection` requests, the same `JobId` is returned. Use `ClientRequestToken` to prevent the same job from being accidentally started more than once. For more information, see [Calling Amazon Textract Asynchronous Operations](https://docs.aws.amazon.com/textract/latest/dg/api-async.html) Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` Required: No ** [DocumentLocation](#API_StartExpenseAnalysis_RequestSyntax) ** The location of the document to be processed. Type: [DocumentLocation](API_DocumentLocation.md) object Required: Yes ** [JobTag](#API_StartExpenseAnalysis_RequestSyntax) ** An identifier you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use `JobTag` to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt). Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9_.\-:]+` Required: No ** [KMSKeyId](#API_StartExpenseAnalysis_RequestSyntax) ** The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` Required: No ** [NotificationChannel](#API_StartExpenseAnalysis_RequestSyntax) ** The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to. Type: [NotificationChannel](API_NotificationChannel.md) object Required: No ** [OutputConfig](#API_StartExpenseAnalysis_RequestSyntax) ** Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the `GetExpenseAnalysis` operation. Type: [OutputConfig](API_OutputConfig.md) object Required: No ## Response Syntax ``` { "JobId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobId](#API_StartExpenseAnalysis_ResponseSyntax) ** A unique identifier for the text detection job. The `JobId` is returned from `StartExpenseAnalysis`. A `JobId` value is only valid for 7 days. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** BadDocumentException ** Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md). HTTP Status Code: 400 ** DocumentTooLargeException ** The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files. HTTP Status Code: 400 ** IdempotentParameterMismatchException ** A `ClientRequestToken` input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidKMSKeyException ** Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. HTTP Status Code: 400 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** LimitExceededException ** An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (`StartDocumentTextDetection`, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** UnsupportedDocumentException ** The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartExpenseAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartExpenseAnalysis) # StartLendingAnalysis Starts the classification and analysis of an input document. `StartLendingAnalysis` initiates the classification and analysis of a packet of lending documents. `StartLendingAnalysis` operates on a document file located in an Amazon S3 bucket. `StartLendingAnalysis` can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use `DocumentLocation` to specify the bucket name and the file name of the document. `StartLendingAnalysis` returns a job identifier (`JobId`) that you use to get the results of the operation. When the text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in `NotificationChannel`. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either `GetLendingAnalysis` or `GetLendingAnalysisSummary` and provide the `JobId` to obtain the results of the analysis. If using `OutputConfig` to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories: + detailedResponse (contains the GetLendingAnalysis response) + summaryResponse (for the GetLendingAnalysisSummary response) + splitDocuments (documents split across logical boundaries) ## Request Syntax ``` { "ClientRequestToken": "string", "DocumentLocation": { "S3Object": { "Bucket": "string", "Name": "string", "Version": "string" } }, "JobTag": "string", "KMSKeyId": "string", "NotificationChannel": { "RoleArn": "string", "SNSTopicArn": "string" }, "OutputConfig": { "S3Bucket": "string", "S3Prefix": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ClientRequestToken](#API_StartLendingAnalysis_RequestSyntax) ** The idempotent token that you use to identify the start request. If you use the same token with multiple `StartLendingAnalysis` requests, the same `JobId` is returned. Use `ClientRequestToken` to prevent the same job from being accidentally started more than once. For more information, see [Calling Amazon Textract Asynchronous Operations](https://docs.aws.amazon.com/textract/latest/dg/api-sync.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` Required: No ** [DocumentLocation](#API_StartLendingAnalysis_RequestSyntax) ** The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations. The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format. Type: [DocumentLocation](API_DocumentLocation.md) object Required: Yes ** [JobTag](#API_StartLendingAnalysis_RequestSyntax) ** An identifier that you specify to be included in the completion notification published to the Amazon SNS topic. For example, you can use `JobTag` to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt). Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9_.\-:]+` Required: No ** [KMSKeyId](#API_StartLendingAnalysis_RequestSyntax) ** The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side, using SSE-S3. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$` Required: No ** [NotificationChannel](#API_StartLendingAnalysis_RequestSyntax) ** The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation. Type: [NotificationChannel](API_NotificationChannel.md) object Required: No ** [OutputConfig](#API_StartLendingAnalysis_RequestSyntax) ** Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file. `OutputConfig` is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With `OutputConfig` enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the `KMSKeyID` parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3. Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see [ Managing AI services opt-out policy. ](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html) For more information on data privacy, see the [Data Privacy FAQ](https://aws.amazon.com/compliance/data-privacy-faq/). Type: [OutputConfig](API_OutputConfig.md) object Required: No ## Response Syntax ``` { "JobId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [JobId](#API_StartLendingAnalysis_ResponseSyntax) ** A unique identifier for the lending or text-detection job. The `JobId` is returned from `StartLendingAnalysis`. A `JobId` value is only valid for 7 days. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9-_]+$` ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** BadDocumentException ** Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see [Quotas in Amazon Textract](limits.md). HTTP Status Code: 400 ** DocumentTooLargeException ** The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files. HTTP Status Code: 400 ** IdempotentParameterMismatchException ** A `ClientRequestToken` input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidKMSKeyException ** Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly. HTTP Status Code: 400 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** InvalidS3ObjectException ** Amazon Textract is unable to access the S3 object that's specified in the request. for more information, [Configure Access to Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) For troubleshooting information, see [Troubleshooting Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) HTTP Status Code: 400 ** LimitExceededException ** An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (`StartDocumentTextDetection`, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** UnsupportedDocumentException ** The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/StartLendingAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/StartLendingAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/StartLendingAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/StartLendingAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/StartLendingAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/StartLendingAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/StartLendingAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/StartLendingAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/StartLendingAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/StartLendingAnalysis) # TagResource Adds one or more tags to the specified resource. ## Request Syntax ``` { "ResourceARN": "string", "Tags": { "string" : "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceARN](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) that specifies the resource to be tagged. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Required: Yes ** [Tags](#API_TagResource_RequestSyntax) ** A set of tags (key-value pairs) that you want to assign to the resource. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$` Value Length Constraints: Minimum length of 0. Maximum length of 256. Value Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ResourceNotFoundException ** Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ** ServiceQuotaExceededException ** Returned when a request cannot be completed as it would exceed a maximum service quota. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** ValidationException ** Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/TagResource) # UntagResource Removes any tags with the specified keys from the specified resource. ## Request Syntax ``` { "ResourceARN": "string", "TagKeys": [ "string" ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceARN](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) that specifies the resource to be untagged. Type: String Length Constraints: Minimum length of 1. Maximum length of 1011. Required: Yes ** [TagKeys](#API_UntagResource_RequestSyntax) ** Specifies the tags to be removed from the resource specified by the ResourceARN. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ResourceNotFoundException ** Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** ValidationException ** Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/UntagResource) # UpdateAdapter Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument. ## Request Syntax ``` { "AdapterId": "string", "AdapterName": "string", "AutoUpdate": "string", "Description": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AdapterId](#API_UpdateAdapter_RequestSyntax) ** A string containing a unique ID for the adapter that will be updated. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. Required: Yes ** [AdapterName](#API_UpdateAdapter_RequestSyntax) ** The new name to be applied to the adapter. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9-_]+` Required: No ** [AutoUpdate](#API_UpdateAdapter_RequestSyntax) ** The new auto-update status to be applied to the adapter. Type: String Valid Values: `ENABLED | DISABLED` Required: No ** [Description](#API_UpdateAdapter_RequestSyntax) ** The new description to be applied to the adapter. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$` Required: No ## Response Syntax ``` { "AdapterId": "string", "AdapterName": "string", "AutoUpdate": "string", "CreationTime": number, "Description": "string", "FeatureTypes": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AdapterId](#API_UpdateAdapter_ResponseSyntax) ** A string containing a unique ID for the adapter that has been updated. Type: String Length Constraints: Minimum length of 12. Maximum length of 1011. ** [AdapterName](#API_UpdateAdapter_ResponseSyntax) ** A string containing the name of the adapter that has been updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9-_]+` ** [AutoUpdate](#API_UpdateAdapter_ResponseSyntax) ** The auto-update status of the adapter that has been updated. Type: String Valid Values: `ENABLED | DISABLED` ** [CreationTime](#API_UpdateAdapter_ResponseSyntax) ** An object specifying the creation time of the the adapter that has been updated. Type: Timestamp ** [Description](#API_UpdateAdapter_ResponseSyntax) ** A string containing the description of the adapter that has been updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$` ** [FeatureTypes](#API_UpdateAdapter_ResponseSyntax) ** List of the targeted feature types for the updated adapter. Type: Array of strings Valid Values: `TABLES | FORMS | QUERIES | SIGNATURES | LAYOUT` ## Errors ** AccessDeniedException ** You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation. HTTP Status Code: 400 ** ConflictException ** Updating or deleting a resource can cause an inconsistent state. HTTP Status Code: 400 ** InternalServerError ** Amazon Textract experienced a service issue. Try your call again. HTTP Status Code: 500 ** InvalidParameterException ** An input parameter violated a constraint. For example, in synchronous operations, an `InvalidParameterException` exception occurs when neither of the `S3Object` or `Bytes` values are supplied in the `Document` request parameter. Validate your parameter before calling the API operation again. HTTP Status Code: 400 ** ProvisionedThroughputExceededException ** The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract. HTTP Status Code: 400 ** ResourceNotFoundException ** Returned when an operation tried to access a nonexistent resource. HTTP Status Code: 400 ** ThrottlingException ** Amazon Textract is temporarily unable to process the request. Try your call again. HTTP Status Code: 500 ** ValidationException ** Indicates that a request was not valid. Check request for proper formatting. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/textract-2018-06-27/UpdateAdapter) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/textract-2018-06-27/UpdateAdapter) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/textract-2018-06-27/UpdateAdapter) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/textract-2018-06-27/UpdateAdapter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/textract-2018-06-27/UpdateAdapter) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/textract-2018-06-27/UpdateAdapter) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/textract-2018-06-27/UpdateAdapter) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/textract-2018-06-27/UpdateAdapter) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/textract-2018-06-27/UpdateAdapter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/textract-2018-06-27/UpdateAdapter)