/AWS1/IF_TEX=>STARTEXPENSEANALYSIS()

About StartExpenseAnalysis

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.

Method Signature

METHODS /AWS1/IF_TEX~STARTEXPENSEANALYSIS
  IMPORTING
    !IO_DOCUMENTLOCATION TYPE REF TO /AWS1/CL_TEXDOCUMENTLOCATION OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/TEXCLIENTREQUESTTOKEN OPTIONAL
    !IV_JOBTAG TYPE /AWS1/TEXJOBTAG OPTIONAL
    !IO_NOTIFICATIONCHANNEL TYPE REF TO /AWS1/CL_TEXNOTIFCHANNEL OPTIONAL
    !IO_OUTPUTCONFIG TYPE REF TO /AWS1/CL_TEXOUTPUTCONFIG OPTIONAL
    !IV_KMSKEYID TYPE /AWS1/TEXKMSKEYID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_texstartexpensealyrsp
  RAISING
    /AWS1/CX_TEXACCESSDENIEDEX
    /AWS1/CX_TEXBADDOCUMENTEX
    /AWS1/CX_TEXDOCUMENTTOOLARGEEX
    /AWS1/CX_TEXIDEMPOTENTPRMMIS00
    /AWS1/CX_TEXINTERNALSERVERERR
    /AWS1/CX_TEXINVALIDKMSKEYEX
    /AWS1/CX_TEXINVALIDPARAMETEREX
    /AWS1/CX_TEXINVALIDS3OBJECTEX
    /AWS1/CX_TEXLIMITEXCEEDEDEX
    /AWS1/CX_TEXPROVTHRUPUTEXCDEX
    /AWS1/CX_TEXTHROTTLINGEX
    /AWS1/CX_TEXUNSUPPORTEDDOCEX
    /AWS1/CX_TEXCLIENTEXC
    /AWS1/CX_TEXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

io_documentlocation TYPE REF TO /AWS1/CL_TEXDOCUMENTLOCATION /AWS1/CL_TEXDOCUMENTLOCATION

The location of the document to be processed.

Optional arguments:

iv_clientrequesttoken TYPE /AWS1/TEXCLIENTREQUESTTOKEN /AWS1/TEXCLIENTREQUESTTOKEN

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

iv_jobtag TYPE /AWS1/TEXJOBTAG /AWS1/TEXJOBTAG

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

io_notificationchannel TYPE REF TO /AWS1/CL_TEXNOTIFCHANNEL /AWS1/CL_TEXNOTIFCHANNEL

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

io_outputconfig TYPE REF TO /AWS1/CL_TEXOUTPUTCONFIG /AWS1/CL_TEXOUTPUTCONFIG

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.

iv_kmskeyid TYPE /AWS1/TEXKMSKEYID /AWS1/TEXKMSKEYID

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_texstartexpensealyrsp /AWS1/CL_TEXSTARTEXPENSEALYRSP

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->startexpenseanalysis(
  io_documentlocation = new /aws1/cl_texdocumentlocation(
    io_s3object = new /aws1/cl_texs3object(
      iv_bucket = |string|
      iv_name = |string|
      iv_version = |string|
    )
  )
  io_notificationchannel = new /aws1/cl_texnotifchannel(
    iv_rolearn = |string|
    iv_snstopicarn = |string|
  )
  io_outputconfig = new /aws1/cl_texoutputconfig(
    iv_s3bucket = |string|
    iv_s3prefix = |string|
  )
  iv_clientrequesttoken = |string|
  iv_jobtag = |string|
  iv_kmskeyid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_jobid = lo_result->get_jobid( ).
ENDIF.