Skip to content

Commit 5537ae3

Browse files
authored
feat(aws-android-sdk-textract): update models to latest (#2733)
1 parent bcdf3ca commit 5537ae3

36 files changed

+5354
-87
lines changed

aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/AmazonTextract.java

Lines changed: 155 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,8 @@ AnalyzeDocumentResult analyzeDocument(AnalyzeDocumentRequest analyzeDocumentRequ
169169

170170
/**
171171
* <p>
172-
* Analyzes an input document for financially related relationships between
173-
* text.
172+
* <code>AnalyzeExpense</code> synchronously analyzes an input document for
173+
* financially related relationships between text.
174174
* </p>
175175
* <p>
176176
* Information is returned as <code>ExpenseDocuments</code> and seperated as
@@ -215,6 +215,36 @@ AnalyzeDocumentResult analyzeDocument(AnalyzeDocumentRequest analyzeDocumentRequ
215215
AnalyzeExpenseResult analyzeExpense(AnalyzeExpenseRequest analyzeExpenseRequest)
216216
throws AmazonClientException, AmazonServiceException;
217217

218+
/**
219+
* <p>
220+
* Analyzes identity documents for relevant information. This information is
221+
* extracted and returned as <code>IdentityDocumentFields</code>, which
222+
* records both the normalized field and value of the extracted text.
223+
* </p>
224+
*
225+
* @param analyzeIDRequest
226+
* @return analyzeIDResult The response from the AnalyzeID service method,
227+
* as returned by Amazon Textract.
228+
* @throws InvalidParameterException
229+
* @throws InvalidS3ObjectException
230+
* @throws UnsupportedDocumentException
231+
* @throws DocumentTooLargeException
232+
* @throws BadDocumentException
233+
* @throws AccessDeniedException
234+
* @throws ProvisionedThroughputExceededException
235+
* @throws InternalServerErrorException
236+
* @throws ThrottlingException
237+
* @throws AmazonClientException If any internal errors are encountered
238+
* inside the client while attempting to make the request or
239+
* handle the response. For example if a network connection is
240+
* not available.
241+
* @throws AmazonServiceException If an error response is returned by Amazon
242+
* Textract indicating either a problem with the data in the
243+
* request, or a server side issue.
244+
*/
245+
AnalyzeIDResult analyzeID(AnalyzeIDRequest analyzeIDRequest) throws AmazonClientException,
246+
AmazonServiceException;
247+
218248
/**
219249
* <p>
220250
* Detects text in the input document. Amazon Textract can detect lines of
@@ -429,6 +459,64 @@ GetDocumentTextDetectionResult getDocumentTextDetection(
429459
GetDocumentTextDetectionRequest getDocumentTextDetectionRequest)
430460
throws AmazonClientException, AmazonServiceException;
431461

462+
/**
463+
* <p>
464+
* Gets the results for an Amazon Textract asynchronous operation that
465+
* analyzes invoices and receipts. Amazon Textract finds contact
466+
* information, items purchased, and vendor name, from input invoices and
467+
* receipts.
468+
* </p>
469+
* <p>
470+
* You start asynchronous invoice/receipt analysis by calling
471+
* <a>StartExpenseAnalysis</a>, which returns a job identifier (
472+
* <code>JobId</code>). Upon completion of the invoice/receipt analysis,
473+
* Amazon Textract publishes the completion status to the Amazon Simple
474+
* Notification Service (Amazon SNS) topic. This topic must be registered in
475+
* the initial call to <code>StartExpenseAnalysis</code>. To get the results
476+
* of the invoice/receipt analysis operation, first ensure that the status
477+
* value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so,
478+
* call <code>GetExpenseAnalysis</code>, and pass the job identifier (
479+
* <code>JobId</code>) from the initial call to
480+
* <code>StartExpenseAnalysis</code>.
481+
* </p>
482+
* <p>
483+
* Use the MaxResults parameter to limit the number of blocks that are
484+
* returned. If there are more results than specified in
485+
* <code>MaxResults</code>, the value of <code>NextToken</code> in the
486+
* operation response contains a pagination token for getting the next set
487+
* of results. To get the next page of results, call
488+
* <code>GetExpenseAnalysis</code>, and populate the <code>NextToken</code>
489+
* request parameter with the token value that's returned from the previous
490+
* call to <code>GetExpenseAnalysis</code>.
491+
* </p>
492+
* <p>
493+
* For more information, see <a href=
494+
* "https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html"
495+
* >Analyzing Invoices and Receipts</a>.
496+
* </p>
497+
*
498+
* @param getExpenseAnalysisRequest
499+
* @return getExpenseAnalysisResult The response from the GetExpenseAnalysis
500+
* service method, as returned by Amazon Textract.
501+
* @throws InvalidParameterException
502+
* @throws AccessDeniedException
503+
* @throws ProvisionedThroughputExceededException
504+
* @throws InvalidJobIdException
505+
* @throws InternalServerErrorException
506+
* @throws ThrottlingException
507+
* @throws InvalidS3ObjectException
508+
* @throws InvalidKMSKeyException
509+
* @throws AmazonClientException If any internal errors are encountered
510+
* inside the client while attempting to make the request or
511+
* handle the response. For example if a network connection is
512+
* not available.
513+
* @throws AmazonServiceException If an error response is returned by Amazon
514+
* Textract indicating either a problem with the data in the
515+
* request, or a server side issue.
516+
*/
517+
GetExpenseAnalysisResult getExpenseAnalysis(GetExpenseAnalysisRequest getExpenseAnalysisRequest)
518+
throws AmazonClientException, AmazonServiceException;
519+
432520
/**
433521
* <p>
434522
* Starts the asynchronous analysis of an input document for relationships
@@ -437,9 +525,9 @@ GetDocumentTextDetectionResult getDocumentTextDetection(
437525
* </p>
438526
* <p>
439527
* <code>StartDocumentAnalysis</code> can analyze text in documents that are
440-
* in JPEG, PNG, and PDF format. The documents are stored in an Amazon S3
441-
* bucket. Use <a>DocumentLocation</a> to specify the bucket name and file
442-
* name of the document.
528+
* in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon
529+
* S3 bucket. Use <a>DocumentLocation</a> to specify the bucket name and
530+
* file name of the document.
443531
* </p>
444532
* <p>
445533
* <code>StartDocumentAnalysis</code> returns a job identifier (
@@ -494,9 +582,9 @@ StartDocumentAnalysisResult startDocumentAnalysis(
494582
* </p>
495583
* <p>
496584
* <code>StartDocumentTextDetection</code> can analyze text in documents
497-
* that are in JPEG, PNG, and PDF format. The documents are stored in an
498-
* Amazon S3 bucket. Use <a>DocumentLocation</a> to specify the bucket name
499-
* and file name of the document.
585+
* that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in
586+
* an Amazon S3 bucket. Use <a>DocumentLocation</a> to specify the bucket
587+
* name and file name of the document.
500588
* </p>
501589
* <p>
502590
* <code>StartTextDetection</code> returns a job identifier (
@@ -544,6 +632,65 @@ StartDocumentTextDetectionResult startDocumentTextDetection(
544632
StartDocumentTextDetectionRequest startDocumentTextDetectionRequest)
545633
throws AmazonClientException, AmazonServiceException;
546634

635+
/**
636+
* <p>
637+
* Starts the asynchronous analysis of invoices or receipts for data like
638+
* contact information, items purchased, and vendor names.
639+
* </p>
640+
* <p>
641+
* <code>StartExpenseAnalysis</code> can analyze text in documents that are
642+
* in JPEG, PNG, and PDF format. The documents must be stored in an Amazon
643+
* S3 bucket. Use the <a>DocumentLocation</a> parameter to specify the name
644+
* of your S3 bucket and the name of the document in that bucket.
645+
* </p>
646+
* <p>
647+
* <code>StartExpenseAnalysis</code> returns a job identifier (
648+
* <code>JobId</code>) that you will provide to
649+
* <code>GetExpenseAnalysis</code> to retrieve the results of the operation.
650+
* When the analysis of the input invoices/receipts is finished, Amazon
651+
* Textract publishes a completion status to the Amazon Simple Notification
652+
* Service (Amazon SNS) topic that you provide to the
653+
* <code>NotificationChannel</code>. To obtain the results of the invoice
654+
* and receipt analysis operation, ensure that the status value published to
655+
* the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call
656+
* <a>GetExpenseAnalysis</a>, and pass the job identifier (
657+
* <code>JobId</code>) that was returned by your call to
658+
* <code>StartExpenseAnalysis</code>.
659+
* </p>
660+
* <p>
661+
* For more information, see <a href=
662+
* "https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html"
663+
* >Analyzing Invoices and Receipts</a>.
664+
* </p>
665+
*
666+
* @param startExpenseAnalysisRequest
667+
* @return startExpenseAnalysisResult The response from the
668+
* StartExpenseAnalysis service method, as returned by Amazon
669+
* Textract.
670+
* @throws InvalidParameterException
671+
* @throws InvalidS3ObjectException
672+
* @throws InvalidKMSKeyException
673+
* @throws UnsupportedDocumentException
674+
* @throws DocumentTooLargeException
675+
* @throws BadDocumentException
676+
* @throws AccessDeniedException
677+
* @throws ProvisionedThroughputExceededException
678+
* @throws InternalServerErrorException
679+
* @throws IdempotentParameterMismatchException
680+
* @throws ThrottlingException
681+
* @throws LimitExceededException
682+
* @throws AmazonClientException If any internal errors are encountered
683+
* inside the client while attempting to make the request or
684+
* handle the response. For example if a network connection is
685+
* not available.
686+
* @throws AmazonServiceException If an error response is returned by Amazon
687+
* Textract indicating either a problem with the data in the
688+
* request, or a server side issue.
689+
*/
690+
StartExpenseAnalysisResult startExpenseAnalysis(
691+
StartExpenseAnalysisRequest startExpenseAnalysisRequest) throws AmazonClientException,
692+
AmazonServiceException;
693+
547694
/**
548695
* Shuts down this client object, releasing any resources that might be held
549696
* open. This is an optional method, and callers are not expected to call

0 commit comments

Comments
 (0)