/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the textract-2018-06-27.normal.json service model. */ using System; using System.Runtime.ExceptionServices; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using System.Net; using Amazon.Textract.Model; using Amazon.Textract.Model.Internal.MarshallTransformations; using Amazon.Textract.Internal; using Amazon.Runtime; using Amazon.Runtime.Internal; using Amazon.Runtime.Internal.Auth; using Amazon.Runtime.Internal.Transform; namespace Amazon.Textract { /// /// Implementation for accessing Textract /// /// Amazon Textract detects and analyzes text in documents and converts it into machine-readable /// text. This is the API reference documentation for Amazon Textract. /// public partial class AmazonTextractClient : AmazonServiceClient, IAmazonTextract { private static IServiceMetadata serviceMetadata = new AmazonTextractMetadata(); #region Constructors /// /// Constructs AmazonTextractClient with the credentials loaded from the application's /// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. /// /// Example App.config with credentials set. /// /// <?xml version="1.0" encoding="utf-8" ?> /// <configuration> /// <appSettings> /// <add key="AWSProfileName" value="AWS Default"/> /// </appSettings> /// </configuration> /// /// /// public AmazonTextractClient() : base(FallbackCredentialsFactory.GetCredentials(), new AmazonTextractConfig()) { } /// /// Constructs AmazonTextractClient with the credentials loaded from the application's /// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. /// /// Example App.config with credentials set. /// /// <?xml version="1.0" encoding="utf-8" ?> /// <configuration> /// <appSettings> /// <add key="AWSProfileName" value="AWS Default"/> /// </appSettings> /// </configuration> /// /// /// /// The region to connect. public AmazonTextractClient(RegionEndpoint region) : base(FallbackCredentialsFactory.GetCredentials(), new AmazonTextractConfig{RegionEndpoint = region}) { } /// /// Constructs AmazonTextractClient with the credentials loaded from the application's /// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. /// /// Example App.config with credentials set. /// /// <?xml version="1.0" encoding="utf-8" ?> /// <configuration> /// <appSettings> /// <add key="AWSProfileName" value="AWS Default"/> /// </appSettings> /// </configuration> /// /// /// /// The AmazonTextractClient Configuration Object public AmazonTextractClient(AmazonTextractConfig config) : base(FallbackCredentialsFactory.GetCredentials(config), config){} /// /// Constructs AmazonTextractClient with AWS Credentials /// /// AWS Credentials public AmazonTextractClient(AWSCredentials credentials) : this(credentials, new AmazonTextractConfig()) { } /// /// Constructs AmazonTextractClient with AWS Credentials /// /// AWS Credentials /// The region to connect. public AmazonTextractClient(AWSCredentials credentials, RegionEndpoint region) : this(credentials, new AmazonTextractConfig{RegionEndpoint = region}) { } /// /// Constructs AmazonTextractClient with AWS Credentials and an /// AmazonTextractClient Configuration object. /// /// AWS Credentials /// The AmazonTextractClient Configuration Object public AmazonTextractClient(AWSCredentials credentials, AmazonTextractConfig clientConfig) : base(credentials, clientConfig) { } /// /// Constructs AmazonTextractClient with AWS Access Key ID and AWS Secret Key /// /// AWS Access Key ID /// AWS Secret Access Key public AmazonTextractClient(string awsAccessKeyId, string awsSecretAccessKey) : this(awsAccessKeyId, awsSecretAccessKey, new AmazonTextractConfig()) { } /// /// Constructs AmazonTextractClient with AWS Access Key ID and AWS Secret Key /// /// AWS Access Key ID /// AWS Secret Access Key /// The region to connect. public AmazonTextractClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region) : this(awsAccessKeyId, awsSecretAccessKey, new AmazonTextractConfig() {RegionEndpoint=region}) { } /// /// Constructs AmazonTextractClient with AWS Access Key ID, AWS Secret Key and an /// AmazonTextractClient Configuration object. /// /// AWS Access Key ID /// AWS Secret Access Key /// The AmazonTextractClient Configuration Object public AmazonTextractClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonTextractConfig clientConfig) : base(awsAccessKeyId, awsSecretAccessKey, clientConfig) { } /// /// Constructs AmazonTextractClient with AWS Access Key ID and AWS Secret Key /// /// AWS Access Key ID /// AWS Secret Access Key /// AWS Session Token public AmazonTextractClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken) : this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonTextractConfig()) { } /// /// Constructs AmazonTextractClient with AWS Access Key ID and AWS Secret Key /// /// AWS Access Key ID /// AWS Secret Access Key /// AWS Session Token /// The region to connect. public AmazonTextractClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region) : this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonTextractConfig{RegionEndpoint = region}) { } /// /// Constructs AmazonTextractClient with AWS Access Key ID, AWS Secret Key and an /// AmazonTextractClient Configuration object. /// /// AWS Access Key ID /// AWS Secret Access Key /// AWS Session Token /// The AmazonTextractClient Configuration Object public AmazonTextractClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonTextractConfig clientConfig) : base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig) { } #endregion #region Overrides /// /// Creates the signer for the service. /// protected override AbstractAWSSigner CreateSigner() { return new AWS4Signer(); } /// /// Customizes the runtime pipeline. /// /// Runtime pipeline for the current client. protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline) { pipeline.RemoveHandler(); pipeline.AddHandlerAfter(new AmazonTextractEndpointResolver()); } /// /// Capture metadata for the service. /// protected override IServiceMetadata ServiceMetadata { get { return serviceMetadata; } } #endregion #region Dispose /// /// Disposes the service client. /// protected override void Dispose(bool disposing) { base.Dispose(disposing); } #endregion #region AnalyzeDocument internal virtual AnalyzeDocumentResponse AnalyzeDocument(AnalyzeDocumentRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = AnalyzeDocumentRequestMarshaller.Instance; options.ResponseUnmarshaller = AnalyzeDocumentResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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 /// 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_RESULT 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_ELEMENT 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. /// /// /// /// For more information, see Document /// Text Analysis. /// ///
/// Container for the necessary parameters to execute the AnalyzeDocument service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AnalyzeDocument service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract isn't able to read the document. For more information on the document /// limits in Amazon Textract, see limits. /// /// /// 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. /// /// /// Indicates you have exceeded the maximum number of active human in the loop workflows /// available /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// /// The format of the input document isn't supported. Documents for operations can be /// in PNG, JPEG, PDF, or TIFF format. /// /// REST API Reference for AnalyzeDocument Operation public virtual Task AnalyzeDocumentAsync(AnalyzeDocumentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = AnalyzeDocumentRequestMarshaller.Instance; options.ResponseUnmarshaller = AnalyzeDocumentResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region AnalyzeExpense internal virtual AnalyzeExpenseResponse AnalyzeExpense(AnalyzeExpenseRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = AnalyzeExpenseRequestMarshaller.Instance; options.ResponseUnmarshaller = AnalyzeExpenseResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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. /// ///
///
/// Container for the necessary parameters to execute the AnalyzeExpense service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AnalyzeExpense service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract isn't able to read the document. For more information on the document /// limits in Amazon Textract, see limits. /// /// /// 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. /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// /// The format of the input document isn't supported. Documents for operations can be /// in PNG, JPEG, PDF, or TIFF format. /// /// REST API Reference for AnalyzeExpense Operation public virtual Task AnalyzeExpenseAsync(AnalyzeExpenseRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = AnalyzeExpenseRequestMarshaller.Instance; options.ResponseUnmarshaller = AnalyzeExpenseResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region AnalyzeID internal virtual AnalyzeIDResponse AnalyzeID(AnalyzeIDRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = AnalyzeIDRequestMarshaller.Instance; options.ResponseUnmarshaller = AnalyzeIDResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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. /// /// Container for the necessary parameters to execute the AnalyzeID service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AnalyzeID service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract isn't able to read the document. For more information on the document /// limits in Amazon Textract, see limits. /// /// /// 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. /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// /// The format of the input document isn't supported. Documents for operations can be /// in PNG, JPEG, PDF, or TIFF format. /// /// REST API Reference for AnalyzeID Operation public virtual Task AnalyzeIDAsync(AnalyzeIDRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = AnalyzeIDRequestMarshaller.Instance; options.ResponseUnmarshaller = AnalyzeIDResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region DetectDocumentText internal virtual DetectDocumentTextResponse DetectDocumentText(DetectDocumentTextRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = DetectDocumentTextRequestMarshaller.Instance; options.ResponseUnmarshaller = DetectDocumentTextResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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 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. /// /// /// /// For more information, see Document /// Text Detection. /// /// /// Container for the necessary parameters to execute the DetectDocumentText service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DetectDocumentText service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract isn't able to read the document. For more information on the document /// limits in Amazon Textract, see limits. /// /// /// 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. /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// /// The format of the input document isn't supported. Documents for operations can be /// in PNG, JPEG, PDF, or TIFF format. /// /// REST API Reference for DetectDocumentText Operation public virtual Task DetectDocumentTextAsync(DetectDocumentTextRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = DetectDocumentTextRequestMarshaller.Instance; options.ResponseUnmarshaller = DetectDocumentTextResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region GetDocumentAnalysis internal virtual GetDocumentAnalysisResponse GetDocumentAnalysis(GetDocumentAnalysisRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = GetDocumentAnalysisRequestMarshaller.Instance; options.ResponseUnmarshaller = GetDocumentAnalysisResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// Gets the results for an Amazon Textract asynchronous operation that analyzes text /// in a document. /// /// /// /// You start asynchronous text analysis by calling StartDocumentAnalysis, 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 objects. The following /// types of information are returned: /// ///
  • /// /// Form data (key-value pairs). The related information is returned in two Block /// objects, each of type KEY_VALUE_SET: a KEY 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_RESULT 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. /// ///
/// /// 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_ELEMENT 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. /// ///
/// Container for the necessary parameters to execute the GetDocumentAnalysis service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDocumentAnalysis service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// An invalid job identifier was passed to an asynchronous analysis operation. /// /// /// Indicates you do not have decrypt permissions with the KMS key entered, or the KMS /// key was entered incorrectly. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// REST API Reference for GetDocumentAnalysis Operation public virtual Task GetDocumentAnalysisAsync(GetDocumentAnalysisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = GetDocumentAnalysisRequestMarshaller.Instance; options.ResponseUnmarshaller = GetDocumentAnalysisResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region GetDocumentTextDetection internal virtual GetDocumentTextDetectionResponse GetDocumentTextDetection(GetDocumentTextDetectionRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = GetDocumentTextDetectionRequestMarshaller.Instance; options.ResponseUnmarshaller = GetDocumentTextDetectionResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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, /// 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 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. /// /// /// Container for the necessary parameters to execute the GetDocumentTextDetection service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDocumentTextDetection service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// An invalid job identifier was passed to an asynchronous analysis operation. /// /// /// Indicates you do not have decrypt permissions with the KMS key entered, or the KMS /// key was entered incorrectly. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// REST API Reference for GetDocumentTextDetection Operation public virtual Task GetDocumentTextDetectionAsync(GetDocumentTextDetectionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = GetDocumentTextDetectionRequestMarshaller.Instance; options.ResponseUnmarshaller = GetDocumentTextDetectionResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region GetExpenseAnalysis internal virtual GetExpenseAnalysisResponse GetExpenseAnalysis(GetExpenseAnalysisRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = GetExpenseAnalysisRequestMarshaller.Instance; options.ResponseUnmarshaller = GetExpenseAnalysisResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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, /// 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. /// /// /// Container for the necessary parameters to execute the GetExpenseAnalysis service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetExpenseAnalysis service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// An invalid job identifier was passed to an asynchronous analysis operation. /// /// /// Indicates you do not have decrypt permissions with the KMS key entered, or the KMS /// key was entered incorrectly. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// REST API Reference for GetExpenseAnalysis Operation public virtual Task GetExpenseAnalysisAsync(GetExpenseAnalysisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = GetExpenseAnalysisRequestMarshaller.Instance; options.ResponseUnmarshaller = GetExpenseAnalysisResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region GetLendingAnalysis internal virtual GetLendingAnalysisResponse GetLendingAnalysis(GetLendingAnalysisRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = GetLendingAnalysisRequestMarshaller.Instance; options.ResponseUnmarshaller = GetLendingAnalysisResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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. /// /// /// Container for the necessary parameters to execute the GetLendingAnalysis service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetLendingAnalysis service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// An invalid job identifier was passed to an asynchronous analysis operation. /// /// /// Indicates you do not have decrypt permissions with the KMS key entered, or the KMS /// key was entered incorrectly. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// REST API Reference for GetLendingAnalysis Operation public virtual Task GetLendingAnalysisAsync(GetLendingAnalysisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = GetLendingAnalysisRequestMarshaller.Instance; options.ResponseUnmarshaller = GetLendingAnalysisResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region GetLendingAnalysisSummary internal virtual GetLendingAnalysisSummaryResponse GetLendingAnalysisSummary(GetLendingAnalysisSummaryRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = GetLendingAnalysisSummaryRequestMarshaller.Instance; options.ResponseUnmarshaller = GetLendingAnalysisSummaryResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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. /// /// /// Container for the necessary parameters to execute the GetLendingAnalysisSummary service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetLendingAnalysisSummary service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// An invalid job identifier was passed to an asynchronous analysis operation. /// /// /// Indicates you do not have decrypt permissions with the KMS key entered, or the KMS /// key was entered incorrectly. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// REST API Reference for GetLendingAnalysisSummary Operation public virtual Task GetLendingAnalysisSummaryAsync(GetLendingAnalysisSummaryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = GetLendingAnalysisSummaryRequestMarshaller.Instance; options.ResponseUnmarshaller = GetLendingAnalysisSummaryResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region StartDocumentAnalysis internal virtual StartDocumentAnalysisResponse StartDocumentAnalysis(StartDocumentAnalysisRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = StartDocumentAnalysisRequestMarshaller.Instance; options.ResponseUnmarshaller = StartDocumentAnalysisResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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 /// 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, /// and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis. /// /// /// /// For more information, see Document /// Text Analysis. /// /// /// Container for the necessary parameters to execute the StartDocumentAnalysis service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartDocumentAnalysis service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract isn't able to read the document. For more information on the document /// limits in Amazon Textract, see limits. /// /// /// 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. /// /// /// 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. /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// Indicates you do not have decrypt permissions with the KMS key entered, or the KMS /// key was entered incorrectly. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// 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. /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// /// The format of the input document isn't supported. Documents for operations can be /// in PNG, JPEG, PDF, or TIFF format. /// /// REST API Reference for StartDocumentAnalysis Operation public virtual Task StartDocumentAnalysisAsync(StartDocumentAnalysisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = StartDocumentAnalysisRequestMarshaller.Instance; options.ResponseUnmarshaller = StartDocumentAnalysisResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region StartDocumentTextDetection internal virtual StartDocumentTextDetectionResponse StartDocumentTextDetection(StartDocumentTextDetectionRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = StartDocumentTextDetectionRequestMarshaller.Instance; options.ResponseUnmarshaller = StartDocumentTextDetectionResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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 to specify the bucket name and file name of the document. /// /// /// /// /// StartTextDetection 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, /// and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection. /// /// /// /// For more information, see Document /// Text Detection. /// /// /// Container for the necessary parameters to execute the StartDocumentTextDetection service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartDocumentTextDetection service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract isn't able to read the document. For more information on the document /// limits in Amazon Textract, see limits. /// /// /// 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. /// /// /// 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. /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// Indicates you do not have decrypt permissions with the KMS key entered, or the KMS /// key was entered incorrectly. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// 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. /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// /// The format of the input document isn't supported. Documents for operations can be /// in PNG, JPEG, PDF, or TIFF format. /// /// REST API Reference for StartDocumentTextDetection Operation public virtual Task StartDocumentTextDetectionAsync(StartDocumentTextDetectionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = StartDocumentTextDetectionRequestMarshaller.Instance; options.ResponseUnmarshaller = StartDocumentTextDetectionResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region StartExpenseAnalysis internal virtual StartExpenseAnalysisResponse StartExpenseAnalysis(StartExpenseAnalysisRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = StartExpenseAnalysisRequestMarshaller.Instance; options.ResponseUnmarshaller = StartExpenseAnalysisResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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 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, /// and pass the job identifier (JobId) that was returned by your call to /// StartExpenseAnalysis. /// /// /// /// For more information, see Analyzing /// Invoices and Receipts. /// /// /// Container for the necessary parameters to execute the StartExpenseAnalysis service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartExpenseAnalysis service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract isn't able to read the document. For more information on the document /// limits in Amazon Textract, see limits. /// /// /// 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. /// /// /// 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. /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// Indicates you do not have decrypt permissions with the KMS key entered, or the KMS /// key was entered incorrectly. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// 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. /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// /// The format of the input document isn't supported. Documents for operations can be /// in PNG, JPEG, PDF, or TIFF format. /// /// REST API Reference for StartExpenseAnalysis Operation public virtual Task StartExpenseAnalysisAsync(StartExpenseAnalysisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = StartExpenseAnalysisRequestMarshaller.Instance; options.ResponseUnmarshaller = StartExpenseAnalysisResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion #region StartLendingAnalysis internal virtual StartLendingAnalysisResponse StartLendingAnalysis(StartLendingAnalysisRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = StartLendingAnalysisRequestMarshaller.Instance; options.ResponseUnmarshaller = StartLendingAnalysisResponseUnmarshaller.Instance; return Invoke(request, options); } /// /// 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) /// ///
///
/// Container for the necessary parameters to execute the StartLendingAnalysis service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartLendingAnalysis service method, as returned by Textract. /// /// 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. /// /// /// Amazon Textract isn't able to read the document. For more information on the document /// limits in Amazon Textract, see limits. /// /// /// 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. /// /// /// 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. /// /// /// Amazon Textract experienced a service issue. Try your call again. /// /// /// Indicates you do not have decrypt permissions with the KMS key entered, or the KMS /// key was entered incorrectly. /// /// /// 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. /// /// /// Amazon Textract is unable to access the S3 object that's specified in the request. /// for more information, Configure /// Access to Amazon S3 For troubleshooting information, see Troubleshooting /// Amazon S3 /// /// /// 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. /// /// /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// /// /// Amazon Textract is temporarily unable to process the request. Try your call again. /// /// /// The format of the input document isn't supported. Documents for operations can be /// in PNG, JPEG, PDF, or TIFF format. /// /// REST API Reference for StartLendingAnalysis Operation public virtual Task StartLendingAnalysisAsync(StartLendingAnalysisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = StartLendingAnalysisRequestMarshaller.Instance; options.ResponseUnmarshaller = StartLendingAnalysisResponseUnmarshaller.Instance; return InvokeAsync(request, options, cancellationToken); } #endregion } }