lending_analysis_summaries

Creates, updates, deletes, gets or lists a lending_analysis_summaries resource.

Overview

Name	lending_analysis_summaries
Type	Resource
Id	aws.textract.lending_analysis_summaries

Fields

The following fields are returned by SELECT queries:

get_lending_analysis_summary

Name	Datatype	Description
analyze_lending_model_version	string	The current model version of the Analyze Lending API.
document_metadata	object	Information about the input document.
job_status	string	The current status of the lending analysis job. (IN_PROGRESS, SUCCEEDED, FAILED, PARTIAL_SUCCESS)
status_message	string	Returns if the lending analysis could not be completed. Contains explanation for what error occurred.
summary	object	Contains summary information for documents grouped by type.
warnings	array	A list of warnings that occurred during the lending analysis operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_lending_analysis_summary	select	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_lending_analysis_summary

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.

SELECT
analyze_lending_model_version,
document_metadata,
job_status,
status_message,
summary,
warnings
FROM aws.textract.lending_analysis_summaries
WHERE region = '{{ region }}' -- required
;