internal virtual GetDocumentTextDetectionResponse GetDocumentTextDetection(GetDocumentTextDetectionRequest request) { var options = new InvokeOptions(); options.RequestMarshaller = GetDocumentTextDetectionRequestMarshaller.Instance; options.ResponseUnmarshaller = GetDocumentTextDetectionResponseUnmarshaller.Instance; return(Invoke <GetDocumentTextDetectionResponse>(request, options)); }
/// <summary> /// 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. /// /// /// <para> /// You start asynchronous text detection by calling <a>StartDocumentTextDetection</a>, /// which returns a job identifier (<code>JobId</code>). 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 <code>StartDocumentTextDetection</code>. /// To get the results of the text-detection operation, first check that the status value /// published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetDocumentTextDetection</code>, /// and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartDocumentTextDetection</code>. /// </para> /// /// <para> /// <code>GetDocumentTextDetection</code> returns an array of <a>Block</a> objects. /// </para> /// /// <para> /// Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE /// <code>Block</code> object is the parent of LINE <code>Block</code> objects that represent /// the lines of detected text on a page. A LINE <code>Block</code> object is a parent /// for each word that makes up the line. Words are represented by <code>Block</code> /// objects of type WORD. /// </para> /// /// <para> /// Use the MaxResults parameter to limit the number of blocks that are returned. If there /// are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> /// in the operation response contains a pagination token for getting the next set of /// results. To get the next page of results, call <code>GetDocumentTextDetection</code>, /// and populate the <code>NextToken</code> request parameter with the token value that's /// returned from the previous call to <code>GetDocumentTextDetection</code>. /// </para> /// /// <para> /// For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document /// Text Detection</a>. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetDocumentTextDetection service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the GetDocumentTextDetection service method, as returned by Textract.</returns> /// <exception cref="Amazon.Textract.Model.AccessDeniedException"> /// You aren't authorized to perform the action. /// </exception> /// <exception cref="Amazon.Textract.Model.InternalServerErrorException"> /// Amazon Textract experienced a service issue. Try your call again. /// </exception> /// <exception cref="Amazon.Textract.Model.InvalidJobIdException"> /// An invalid job identifier was passed to <a>GetDocumentAnalysis</a> or to <a>GetDocumentAnalysis</a>. /// </exception> /// <exception cref="Amazon.Textract.Model.InvalidParameterException"> /// An input parameter violated a constraint. For example, in synchronous operations, /// an <code>InvalidParameterException</code> exception occurs when neither of the <code>S3Object</code> /// or <code>Bytes</code> values are supplied in the <code>Document</code> request parameter. /// Validate your parameter before calling the API operation again. /// </exception> /// <exception cref="Amazon.Textract.Model.ProvisionedThroughputExceededException"> /// The number of requests exceeded your throughput limit. If you want to increase this /// limit, contact Amazon Textract. /// </exception> /// <exception cref="Amazon.Textract.Model.ThrottlingException"> /// Amazon Textract is temporarily unable to process the request. Try your call again. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentTextDetection">REST API Reference for GetDocumentTextDetection Operation</seealso> public virtual Task <GetDocumentTextDetectionResponse> GetDocumentTextDetectionAsync(GetDocumentTextDetectionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var options = new InvokeOptions(); options.RequestMarshaller = GetDocumentTextDetectionRequestMarshaller.Instance; options.ResponseUnmarshaller = GetDocumentTextDetectionResponseUnmarshaller.Instance; return(InvokeAsync <GetDocumentTextDetectionResponse>(request, options, cancellationToken)); }