API for AWS Comprehend Medical¶

ABAP Package	`/AWS1/API_CPM_IMPL`
ABAP SDK "TLA"	`CPM`
ABAP Interface	`/AWS1/IF_CPM`

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 AWS Comprehend Medical is CPM. 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 ComprehendMedical 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 Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see Guidelines and quotas in the Amazon Comprehend Medical Developer Guide.

Using the SDK¶

In your code, create a client using the SDK module for AWS Comprehend Medical, which is created with factory method /AWS1/CL_CPM_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_cpm)       = /aws1/cl_cpm_factory=>create( go_session ).

Your variable go_cpm is an instance of /AWS1/IF_CPM, and all of the operations in the AWS Comprehend Medical service are accessed by calling methods in /AWS1/IF_CPM.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS Comprehend Medical, see the Operation List.

Factory Method¶

`/AWS1/CL_CPM_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_CPM.

IMPORTING¶

Optional arguments:¶

`IV_PROTOCOL` `TYPE /AWS1/RT_PROTOCOL` `/AWS1/RT_PROTOCOL`¶

`IO_SESSION` `TYPE REF TO /AWS1/CL_RT_SESSION_BASE` `/AWS1/CL_RT_SESSION_BASE`¶

`IV_REGION` `TYPE /AWS1/RT_REGION_ID` `/AWS1/RT_REGION_ID`¶

`IV_CUSTOM_ENDPOINT` `TYPE /AWS1/RT_ENDPOINT` `/AWS1/RT_ENDPOINT`¶

RETURNING¶

`OO_CLIENT` `TYPE REF TO /AWS1/IF_CPM` `/AWS1/IF_CPM`¶

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

Configuring Programmatically¶

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

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