Skip to content

API for Amazon Textract

ABAP Package /AWS1/API_TEX_IMPL
ABAP SDK "TLA" TEX
ABAP Interface /AWS1/IF_TEX

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for Amazon Textract is TEX. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the Textract module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service

Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.

Using the SDK

In your code, create a client using the SDK module for Amazon Textract, which is created with factory method /AWS1/CL_TEX_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_tex)       = /aws1/cl_tex_factory=>create( go_session ).

Your variable go_tex is an instance of /AWS1/IF_TEX, and all of the operations in the Amazon Textract service are accessed by calling methods in /AWS1/IF_TEX.

API Operations

For an overview of ABAP method calls corresponding to API operations in Amazon Textract, see the Operation List.

Factory Method

/AWS1/CL_TEX_FACTORY=>create( )

Creates an object of type /AWS1/IF_TEX.

IMPORTING

Required arguments:

IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE

Optional arguments:

IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL

IV_REGION TYPE /AWS1/RT_REGION_ID

IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT

RETURNING

OO_CLIENT TYPE REF TO /AWS1/IF_TEX

/AWS1/IF_TEX represents the ABAP client for the Textract service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically

DATA(lo_config) = DATA(go_tex)->get_config( ).

lo_config is a variable of type /AWS1/CL_TEX_CONFIG. See the documentation for /AWS1/CL_TEX_CONFIG for details on the settings that can be configured.