| 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.StartExpenseAnalysis
Description
Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.
StartExpenseAnalysis can analyze text in documents that are in JPEG,
PNG, and PDF format. The documents must be stored in an Amazon S3
bucket. Use the DocumentLocation parameter to specify the name of your
S3 bucket and the name of the document in that bucket.
StartExpenseAnalysis returns a job identifier (JobId) that you will
provide to GetExpenseAnalysis to retrieve the results of the
operation. When the analysis of the input invoices/receipts is
finished, Amazon Textract publishes a completion status to the Amazon
Simple Notification Service (Amazon SNS) topic that you provide to the
NotificationChannel. To obtain the results of the invoice and receipt
analysis operation, ensure that the status value published to the Amazon
SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the
job identifier (JobId) that was returned by your call to
StartExpenseAnalysis.
For more information, see Analyzing Invoices and Receipts.
Synopsis
- data StartExpenseAnalysis = StartExpenseAnalysis' {}
- newStartExpenseAnalysis :: DocumentLocation -> StartExpenseAnalysis
- startExpenseAnalysis_clientRequestToken :: Lens' StartExpenseAnalysis (Maybe Text)
- startExpenseAnalysis_jobTag :: Lens' StartExpenseAnalysis (Maybe Text)
- startExpenseAnalysis_kmsKeyId :: Lens' StartExpenseAnalysis (Maybe Text)
- startExpenseAnalysis_notificationChannel :: Lens' StartExpenseAnalysis (Maybe NotificationChannel)
- startExpenseAnalysis_outputConfig :: Lens' StartExpenseAnalysis (Maybe OutputConfig)
- startExpenseAnalysis_documentLocation :: Lens' StartExpenseAnalysis DocumentLocation
- data StartExpenseAnalysisResponse = StartExpenseAnalysisResponse' {
- jobId :: Maybe Text
- httpStatus :: Int
- newStartExpenseAnalysisResponse :: Int -> StartExpenseAnalysisResponse
- startExpenseAnalysisResponse_jobId :: Lens' StartExpenseAnalysisResponse (Maybe Text)
- startExpenseAnalysisResponse_httpStatus :: Lens' StartExpenseAnalysisResponse Int
Creating a Request
data StartExpenseAnalysis Source #
See: newStartExpenseAnalysis smart constructor.
Constructors
| StartExpenseAnalysis' | |
Fields
| |
Instances
newStartExpenseAnalysis Source #
Create a value of StartExpenseAnalysis 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:clientRequestToken:StartExpenseAnalysis', startExpenseAnalysis_clientRequestToken - The idempotent token that's used to identify the start request. If you
use the same token with multiple StartDocumentTextDetection requests,
the same JobId is returned. Use ClientRequestToken to prevent the
same job from being accidentally started more than once. For more
information, see
Calling Amazon Textract Asynchronous Operations
$sel:jobTag:StartExpenseAnalysis', startExpenseAnalysis_jobTag - An identifier you specify that's included in the completion
notification published to the Amazon SNS topic. For example, you can use
JobTag to identify the type of document that the completion
notification corresponds to (such as a tax form or a receipt).
$sel:kmsKeyId:StartExpenseAnalysis', startExpenseAnalysis_kmsKeyId - The KMS key used to encrypt the inference results. This can be in either
Key ID or Key Alias format. When a KMS key is provided, the KMS key will
be used for server-side encryption of the objects in the customer
bucket. When this parameter is not enabled, the result will be encrypted
server side,using SSE-S3.
$sel:notificationChannel:StartExpenseAnalysis', startExpenseAnalysis_notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the
completion status of the operation to.
$sel:outputConfig:StartExpenseAnalysis', startExpenseAnalysis_outputConfig - Sets if the output will go to a customer defined bucket. By default,
Amazon Textract will save the results internally to be accessed by the
GetExpenseAnalysis operation.
$sel:documentLocation:StartExpenseAnalysis', startExpenseAnalysis_documentLocation - The location of the document to be processed.
Request Lenses
startExpenseAnalysis_clientRequestToken :: Lens' StartExpenseAnalysis (Maybe Text) Source #
The idempotent token that's used to identify the start request. If you
use the same token with multiple StartDocumentTextDetection requests,
the same JobId is returned. Use ClientRequestToken to prevent the
same job from being accidentally started more than once. For more
information, see
Calling Amazon Textract Asynchronous Operations
startExpenseAnalysis_jobTag :: Lens' StartExpenseAnalysis (Maybe Text) Source #
An identifier you specify that's included in the completion
notification published to the Amazon SNS topic. For example, you can use
JobTag to identify the type of document that the completion
notification corresponds to (such as a tax form or a receipt).
startExpenseAnalysis_kmsKeyId :: Lens' StartExpenseAnalysis (Maybe Text) Source #
The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.
startExpenseAnalysis_notificationChannel :: Lens' StartExpenseAnalysis (Maybe NotificationChannel) Source #
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
startExpenseAnalysis_outputConfig :: Lens' StartExpenseAnalysis (Maybe OutputConfig) Source #
Sets if the output will go to a customer defined bucket. By default,
Amazon Textract will save the results internally to be accessed by the
GetExpenseAnalysis operation.
startExpenseAnalysis_documentLocation :: Lens' StartExpenseAnalysis DocumentLocation Source #
The location of the document to be processed.
Destructuring the Response
data StartExpenseAnalysisResponse Source #
See: newStartExpenseAnalysisResponse smart constructor.
Constructors
| StartExpenseAnalysisResponse' | |
Fields
| |
Instances
newStartExpenseAnalysisResponse Source #
Create a value of StartExpenseAnalysisResponse 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:StartExpenseAnalysisResponse', startExpenseAnalysisResponse_jobId - A unique identifier for the text detection job. The JobId is returned
from StartExpenseAnalysis. A JobId value is only valid for 7 days.
$sel:httpStatus:StartExpenseAnalysisResponse', startExpenseAnalysisResponse_httpStatus - The response's http status code.
Response Lenses
startExpenseAnalysisResponse_jobId :: Lens' StartExpenseAnalysisResponse (Maybe 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.
startExpenseAnalysisResponse_httpStatus :: Lens' StartExpenseAnalysisResponse Int Source #
The response's http status code.