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.GetLendingAnalysis

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data GetLendingAnalysis Source #

See: newGetLendingAnalysis smart constructor.

Constructors

GetLendingAnalysis'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.
nextToken :: Maybe Text
If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.
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 GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods toJSON :: GetLendingAnalysis -> Value # toEncoding :: GetLendingAnalysis -> Encoding # toJSONList :: [GetLendingAnalysis] -> Value # toEncodingList :: [GetLendingAnalysis] -> Encoding #
ToHeaders GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods toHeaders :: GetLendingAnalysis -> [Header] #
ToPath GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods toPath :: GetLendingAnalysis -> ByteString #
ToQuery GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods toQuery :: GetLendingAnalysis -> QueryString #
AWSRequest GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Associated Types type AWSResponse GetLendingAnalysis # Methods request :: (Service -> Service) -> GetLendingAnalysis -> Request GetLendingAnalysis # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetLendingAnalysis -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetLendingAnalysis))) #
Generic GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Associated Types type Rep GetLendingAnalysis :: Type -> Type # Methods from :: GetLendingAnalysis -> Rep GetLendingAnalysis x # to :: Rep GetLendingAnalysis x -> GetLendingAnalysis #
Read GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods readsPrec :: Int -> ReadS GetLendingAnalysis # readList :: ReadS [GetLendingAnalysis] # readPrec :: ReadPrec GetLendingAnalysis # readListPrec :: ReadPrec [GetLendingAnalysis] #
Show GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods showsPrec :: Int -> GetLendingAnalysis -> ShowS # show :: GetLendingAnalysis -> String # showList :: [GetLendingAnalysis] -> ShowS #
NFData GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods rnf :: GetLendingAnalysis -> () #
Eq GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods (==) :: GetLendingAnalysis -> GetLendingAnalysis -> Bool # (/=) :: GetLendingAnalysis -> GetLendingAnalysis -> Bool #
Hashable GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods hashWithSalt :: Int -> GetLendingAnalysis -> Int # hash :: GetLendingAnalysis -> Int #
type AWSResponse GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis type AWSResponse GetLendingAnalysis = GetLendingAnalysisResponse
type Rep GetLendingAnalysis Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis type Rep GetLendingAnalysis = D1 ('MetaData "GetLendingAnalysis" "Amazonka.Textract.GetLendingAnalysis" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "GetLendingAnalysis'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetLendingAnalysis Source #

Arguments

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

Create a value of GetLendingAnalysis 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:maxResults:GetLendingAnalysis', getLendingAnalysis_maxResults - The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.

GetLendingAnalysis, getLendingAnalysis_nextToken - If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.

$sel:jobId:GetLendingAnalysis', getLendingAnalysis_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

getLendingAnalysis_maxResults :: Lens' GetLendingAnalysis (Maybe Natural) Source #

The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.

getLendingAnalysis_nextToken :: Lens' GetLendingAnalysis (Maybe Text) Source #

If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.

getLendingAnalysis_jobId :: Lens' GetLendingAnalysis 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 GetLendingAnalysisResponse Source #

See: newGetLendingAnalysisResponse smart constructor.

Constructors

GetLendingAnalysisResponse'

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.
nextToken :: Maybe Text
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of lending results.
results :: Maybe [LendingResult]
Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.
statusMessage :: Maybe Text
Returns if the lending analysis job could not be completed. Contains explanation for what error occurred.
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 GetLendingAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Associated Types type Rep GetLendingAnalysisResponse :: Type -> Type # Methods from :: GetLendingAnalysisResponse -> Rep GetLendingAnalysisResponse x # to :: Rep GetLendingAnalysisResponse x -> GetLendingAnalysisResponse #
Read GetLendingAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods readsPrec :: Int -> ReadS GetLendingAnalysisResponse # readList :: ReadS [GetLendingAnalysisResponse] # readPrec :: ReadPrec GetLendingAnalysisResponse # readListPrec :: ReadPrec [GetLendingAnalysisResponse] #
Show GetLendingAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods showsPrec :: Int -> GetLendingAnalysisResponse -> ShowS # show :: GetLendingAnalysisResponse -> String # showList :: [GetLendingAnalysisResponse] -> ShowS #
NFData GetLendingAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods rnf :: GetLendingAnalysisResponse -> () #
Eq GetLendingAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis Methods (==) :: GetLendingAnalysisResponse -> GetLendingAnalysisResponse -> Bool # (/=) :: GetLendingAnalysisResponse -> GetLendingAnalysisResponse -> Bool #
type Rep GetLendingAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetLendingAnalysis type Rep GetLendingAnalysisResponse = D1 ('MetaData "GetLendingAnalysisResponse" "Amazonka.Textract.GetLendingAnalysis" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "GetLendingAnalysisResponse'" '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 "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LendingResult])) :: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Warning])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetLendingAnalysisResponse Source #

Arguments

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

Create a value of GetLendingAnalysisResponse 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:GetLendingAnalysisResponse', getLendingAnalysisResponse_analyzeLendingModelVersion - The current model version of the Analyze Lending API.

$sel:documentMetadata:GetLendingAnalysisResponse', getLendingAnalysisResponse_documentMetadata - Undocumented member.

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

GetLendingAnalysis, getLendingAnalysisResponse_nextToken - If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of lending results.

$sel:results:GetLendingAnalysisResponse', getLendingAnalysisResponse_results - Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.

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

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

$sel:httpStatus:GetLendingAnalysisResponse', getLendingAnalysisResponse_httpStatus - The response's http status code.

Response Lenses

getLendingAnalysisResponse_analyzeLendingModelVersion :: Lens' GetLendingAnalysisResponse (Maybe Text) Source #

The current model version of the Analyze Lending API.

getLendingAnalysisResponse_documentMetadata :: Lens' GetLendingAnalysisResponse (Maybe DocumentMetadata) Source #

Undocumented member.

getLendingAnalysisResponse_jobStatus :: Lens' GetLendingAnalysisResponse (Maybe JobStatus) Source #

The current status of the lending analysis job.

getLendingAnalysisResponse_nextToken :: Lens' GetLendingAnalysisResponse (Maybe Text) Source #

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of lending results.

getLendingAnalysisResponse_results :: Lens' GetLendingAnalysisResponse (Maybe [LendingResult]) Source #

Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.

getLendingAnalysisResponse_statusMessage :: Lens' GetLendingAnalysisResponse (Maybe Text) Source #

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

getLendingAnalysisResponse_warnings :: Lens' GetLendingAnalysisResponse (Maybe [Warning]) Source #

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

getLendingAnalysisResponse_httpStatus :: Lens' GetLendingAnalysisResponse Int Source #

The response's http status code.