AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetLendingAnalysisSummaryAsync.

Namespace: Amazon.Textract
Assembly: AWSSDK.Textract.dll
Version: 3.x.y.z

Syntax

C#
public virtual GetLendingAnalysisSummaryResponse GetLendingAnalysisSummary(
         GetLendingAnalysisSummaryRequest request
)

Parameters

request
Type: Amazon.Textract.Model.GetLendingAnalysisSummaryRequest

Container for the necessary parameters to execute the GetLendingAnalysisSummary service method.

Return Value


The response from the GetLendingAnalysisSummary service method, as returned by Textract.

Exceptions

ExceptionCondition
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.
InternalServerErrorException Amazon Textract experienced a service issue. Try your call again.
InvalidJobIdException An invalid job identifier was passed to an asynchronous analysis operation.
InvalidKMSKeyException Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
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.
InvalidS3ObjectException 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
ProvisionedThroughputExceededException The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
ThrottlingException Amazon Textract is temporarily unable to process the request. Try your call again.

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also