Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Textract.GetLendingAnalysisSummary

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data GetLendingAnalysisSummary Source #

See: newGetLendingAnalysisSummary smart constructor.

Constructors

GetLendingAnalysisSummary'
Fields jobId :: Text 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.

Instances

Instances details

ToJSON GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods toJSON :: GetLendingAnalysisSummary -> Value # toEncoding :: GetLendingAnalysisSummary -> Encoding # toJSONList :: [GetLendingAnalysisSummary] -> Value # toEncodingList :: [GetLendingAnalysisSummary] -> Encoding #
ToHeaders GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods toHeaders :: GetLendingAnalysisSummary -> [Header] #
ToPath GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods toPath :: GetLendingAnalysisSummary -> ByteString #
ToQuery GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods toQuery :: GetLendingAnalysisSummary -> QueryString #
AWSRequest GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Associated Types type AWSResponse GetLendingAnalysisSummary # Methods request :: (Service -> Service) -> GetLendingAnalysisSummary -> Request GetLendingAnalysisSummary # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetLendingAnalysisSummary -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetLendingAnalysisSummary))) #
Generic GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Associated Types type Rep GetLendingAnalysisSummary :: Type -> Type # Methods from :: GetLendingAnalysisSummary -> Rep GetLendingAnalysisSummary x # to :: Rep GetLendingAnalysisSummary x -> GetLendingAnalysisSummary #
Read GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods readsPrec :: Int -> ReadS GetLendingAnalysisSummary # readList :: ReadS [GetLendingAnalysisSummary] # readPrec :: ReadPrec GetLendingAnalysisSummary # readListPrec :: ReadPrec [GetLendingAnalysisSummary] #
Show GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods showsPrec :: Int -> GetLendingAnalysisSummary -> ShowS # show :: GetLendingAnalysisSummary -> String # showList :: [GetLendingAnalysisSummary] -> ShowS #
NFData GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods rnf :: GetLendingAnalysisSummary -> () #
Eq GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods (==) :: GetLendingAnalysisSummary -> GetLendingAnalysisSummary -> Bool # (/=) :: GetLendingAnalysisSummary -> GetLendingAnalysisSummary -> Bool #
Hashable GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods hashWithSalt :: Int -> GetLendingAnalysisSummary -> Int # hash :: GetLendingAnalysisSummary -> Int #
type AWSResponse GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary type AWSResponse GetLendingAnalysisSummary = GetLendingAnalysisSummaryResponse
type Rep GetLendingAnalysisSummary Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary type Rep GetLendingAnalysisSummary = D1 ('MetaData "GetLendingAnalysisSummary" "Amazonka.Textract.GetLendingAnalysisSummary" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "GetLendingAnalysisSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetLendingAnalysisSummary Source #

Arguments

:: Text	`$sel:jobId:GetLendingAnalysisSummary'`
-> GetLendingAnalysisSummary

Create a value of GetLendingAnalysisSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:GetLendingAnalysisSummary', getLendingAnalysisSummary_jobId - 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.

Request Lenses

getLendingAnalysisSummary_jobId :: Lens' GetLendingAnalysisSummary Text Source #

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.

Destructuring the Response

data GetLendingAnalysisSummaryResponse Source #

See: newGetLendingAnalysisSummaryResponse smart constructor.

Constructors

GetLendingAnalysisSummaryResponse'

Fields

analyzeLendingModelVersion :: Maybe Text
The current model version of the Analyze Lending API.
documentMetadata :: Maybe DocumentMetadata
jobStatus :: Maybe JobStatus
The current status of the lending analysis job.
statusMessage :: Maybe Text
Returns if the lending analysis could not be completed. Contains explanation for what error occurred.
summary :: Maybe LendingSummary
Contains summary information for documents grouped by type.
warnings :: Maybe [Warning]
A list of warnings that occurred during the lending analysis operation.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetLendingAnalysisSummaryResponse Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Associated Types type Rep GetLendingAnalysisSummaryResponse :: Type -> Type # Methods from :: GetLendingAnalysisSummaryResponse -> Rep GetLendingAnalysisSummaryResponse x # to :: Rep GetLendingAnalysisSummaryResponse x -> GetLendingAnalysisSummaryResponse #
Read GetLendingAnalysisSummaryResponse Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods readsPrec :: Int -> ReadS GetLendingAnalysisSummaryResponse # readList :: ReadS [GetLendingAnalysisSummaryResponse] # readPrec :: ReadPrec GetLendingAnalysisSummaryResponse # readListPrec :: ReadPrec [GetLendingAnalysisSummaryResponse] #
Show GetLendingAnalysisSummaryResponse Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods showsPrec :: Int -> GetLendingAnalysisSummaryResponse -> ShowS # show :: GetLendingAnalysisSummaryResponse -> String # showList :: [GetLendingAnalysisSummaryResponse] -> ShowS #
NFData GetLendingAnalysisSummaryResponse Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods rnf :: GetLendingAnalysisSummaryResponse -> () #
Eq GetLendingAnalysisSummaryResponse Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary Methods (==) :: GetLendingAnalysisSummaryResponse -> GetLendingAnalysisSummaryResponse -> Bool # (/=) :: GetLendingAnalysisSummaryResponse -> GetLendingAnalysisSummaryResponse -> Bool #
type Rep GetLendingAnalysisSummaryResponse Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysisSummary type Rep GetLendingAnalysisSummaryResponse = D1 ('MetaData "GetLendingAnalysisSummaryResponse" "Amazonka.Textract.GetLendingAnalysisSummary" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "GetLendingAnalysisSummaryResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "analyzeLendingModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata)) :: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)))) :: ((S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LendingSummary))) :: (S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Warning])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetLendingAnalysisSummaryResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetLendingAnalysisSummaryResponse'`
-> GetLendingAnalysisSummaryResponse

Create a value of GetLendingAnalysisSummaryResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:analyzeLendingModelVersion:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_analyzeLendingModelVersion - The current model version of the Analyze Lending API.

$sel:documentMetadata:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_documentMetadata - Undocumented member.

$sel:jobStatus:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_jobStatus - The current status of the lending analysis job.

$sel:statusMessage:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_statusMessage - Returns if the lending analysis could not be completed. Contains explanation for what error occurred.

$sel:summary:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_summary - Contains summary information for documents grouped by type.

$sel:warnings:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_warnings - A list of warnings that occurred during the lending analysis operation.

$sel:httpStatus:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_httpStatus - The response's http status code.

Response Lenses

getLendingAnalysisSummaryResponse_analyzeLendingModelVersion :: Lens' GetLendingAnalysisSummaryResponse (Maybe Text) Source #

The current model version of the Analyze Lending API.

getLendingAnalysisSummaryResponse_documentMetadata :: Lens' GetLendingAnalysisSummaryResponse (Maybe DocumentMetadata) Source #

Undocumented member.

getLendingAnalysisSummaryResponse_jobStatus :: Lens' GetLendingAnalysisSummaryResponse (Maybe JobStatus) Source #

The current status of the lending analysis job.

getLendingAnalysisSummaryResponse_statusMessage :: Lens' GetLendingAnalysisSummaryResponse (Maybe Text) Source #

Returns if the lending analysis could not be completed. Contains explanation for what error occurred.

getLendingAnalysisSummaryResponse_summary :: Lens' GetLendingAnalysisSummaryResponse (Maybe LendingSummary) Source #

Contains summary information for documents grouped by type.

getLendingAnalysisSummaryResponse_warnings :: Lens' GetLendingAnalysisSummaryResponse (Maybe [Warning]) Source #

A list of warnings that occurred during the lending analysis operation.

getLendingAnalysisSummaryResponse_httpStatus :: Lens' GetLendingAnalysisSummaryResponse Int Source #

The response's http status code.