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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.

You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which returns a job identifier (JobId). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to StartExpenseAnalysis. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) from the initial call to StartExpenseAnalysis.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetExpenseAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetExpenseAnalysis.

For more information, see Analyzing Invoices and Receipts.

Synopsis

Creating a Request

data GetExpenseAnalysis Source #

See: newGetExpenseAnalysis smart constructor.

Constructors

GetExpenseAnalysis'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.
nextToken :: Maybe Text
If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.
jobId :: Text
A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis. A JobId value is only valid for 7 days.

Instances

Instances details

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

newGetExpenseAnalysis Source #

Arguments

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

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

GetExpenseAnalysis, getExpenseAnalysis_nextToken - If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

$sel:jobId:GetExpenseAnalysis', getExpenseAnalysis_jobId - A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis. A JobId value is only valid for 7 days.

Request Lenses

getExpenseAnalysis_maxResults :: Lens' GetExpenseAnalysis (Maybe Natural) Source #

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

getExpenseAnalysis_nextToken :: Lens' GetExpenseAnalysis (Maybe Text) Source #

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

getExpenseAnalysis_jobId :: Lens' GetExpenseAnalysis Text Source #

A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis. A JobId value is only valid for 7 days.

Destructuring the Response

data GetExpenseAnalysisResponse Source #

See: newGetExpenseAnalysisResponse smart constructor.

Constructors

GetExpenseAnalysisResponse'

Fields

analyzeExpenseModelVersion :: Maybe Text
The current model version of AnalyzeExpense.
documentMetadata :: Maybe DocumentMetadata
Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract operation.
expenseDocuments :: Maybe [ExpenseDocument]
The expenses detected by Amazon Textract.
jobStatus :: Maybe JobStatus
The current status of the text detection 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 text-detection results.
statusMessage :: Maybe Text
Returns if the detection job could not be completed. Contains explanation for what error occured.
warnings :: Maybe [Warning]
A list of warnings that occurred during the text-detection operation for the document.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetExpenseAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetExpenseAnalysis Associated Types type Rep GetExpenseAnalysisResponse :: Type -> Type # Methods from :: GetExpenseAnalysisResponse -> Rep GetExpenseAnalysisResponse x # to :: Rep GetExpenseAnalysisResponse x -> GetExpenseAnalysisResponse #
Read GetExpenseAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetExpenseAnalysis Methods readsPrec :: Int -> ReadS GetExpenseAnalysisResponse # readList :: ReadS [GetExpenseAnalysisResponse] # readPrec :: ReadPrec GetExpenseAnalysisResponse # readListPrec :: ReadPrec [GetExpenseAnalysisResponse] #
Show GetExpenseAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetExpenseAnalysis Methods showsPrec :: Int -> GetExpenseAnalysisResponse -> ShowS # show :: GetExpenseAnalysisResponse -> String # showList :: [GetExpenseAnalysisResponse] -> ShowS #
NFData GetExpenseAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetExpenseAnalysis Methods rnf :: GetExpenseAnalysisResponse -> () #
Eq GetExpenseAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetExpenseAnalysis Methods (==) :: GetExpenseAnalysisResponse -> GetExpenseAnalysisResponse -> Bool # (/=) :: GetExpenseAnalysisResponse -> GetExpenseAnalysisResponse -> Bool #
type Rep GetExpenseAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetExpenseAnalysis type Rep GetExpenseAnalysisResponse = D1 ('MetaData "GetExpenseAnalysisResponse" "Amazonka.Textract.GetExpenseAnalysis" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "GetExpenseAnalysisResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "analyzeExpenseModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata))) :: (S1 ('MetaSel ('Just "expenseDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExpenseDocument])) :: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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)))))

newGetExpenseAnalysisResponse Source #

Arguments

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

Create a value of GetExpenseAnalysisResponse 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:analyzeExpenseModelVersion:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_analyzeExpenseModelVersion - The current model version of AnalyzeExpense.

$sel:documentMetadata:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_documentMetadata - Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract operation.

$sel:expenseDocuments:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_expenseDocuments - The expenses detected by Amazon Textract.

$sel:jobStatus:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_jobStatus - The current status of the text detection job.

GetExpenseAnalysis, getExpenseAnalysisResponse_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 text-detection results.

$sel:statusMessage:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_statusMessage - Returns if the detection job could not be completed. Contains explanation for what error occured.

$sel:warnings:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_warnings - A list of warnings that occurred during the text-detection operation for the document.

$sel:httpStatus:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_httpStatus - The response's http status code.

Response Lenses

getExpenseAnalysisResponse_analyzeExpenseModelVersion :: Lens' GetExpenseAnalysisResponse (Maybe Text) Source #

The current model version of AnalyzeExpense.

getExpenseAnalysisResponse_documentMetadata :: Lens' GetExpenseAnalysisResponse (Maybe DocumentMetadata) Source #

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract operation.

getExpenseAnalysisResponse_expenseDocuments :: Lens' GetExpenseAnalysisResponse (Maybe [ExpenseDocument]) Source #

The expenses detected by Amazon Textract.

getExpenseAnalysisResponse_jobStatus :: Lens' GetExpenseAnalysisResponse (Maybe JobStatus) Source #

The current status of the text detection job.

getExpenseAnalysisResponse_nextToken :: Lens' GetExpenseAnalysisResponse (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 text-detection results.

getExpenseAnalysisResponse_statusMessage :: Lens' GetExpenseAnalysisResponse (Maybe Text) Source #

Returns if the detection job could not be completed. Contains explanation for what error occured.

getExpenseAnalysisResponse_warnings :: Lens' GetExpenseAnalysisResponse (Maybe [Warning]) Source #

A list of warnings that occurred during the text-detection operation for the document.

getExpenseAnalysisResponse_httpStatus :: Lens' GetExpenseAnalysisResponse Int Source #

The response's http status code.