Skip to content

API for Amazon Omics

ABAP Package /AWS1/API_OMX_IMPL
ABAP SDK "TLA" OMX
ABAP Interface /AWS1/IF_OMX

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 Omics is OMX. 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 Omics 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

This is the AWS HealthOmics API Reference. For an introduction to the service, see What is AWS HealthOmics? in the AWS HealthOmics User Guide.

Using the SDK

In your code, create a client using the SDK module for Amazon Omics, which is created with factory method /AWS1/CL_OMX_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_omx)       = /aws1/cl_omx_factory=>create( go_session ).

Your variable go_omx is an instance of /AWS1/IF_OMX, and all of the operations in the Amazon Omics service are accessed by calling methods in /AWS1/IF_OMX.

API Operations

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

Factory Method

/AWS1/CL_OMX_FACTORY=>create( )

Creates an object of type /AWS1/IF_OMX.

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_OMX

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

Configuring Programmatically

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

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

Waiters

Waiters for Implementation can be accessed via get_waiter() method followed by the waiter method to be called.

Details about the waiter methods available for service Implementation can be found in interface /AWS1/IF_OMX_WAITER.

Paginators

Paginators for Amazon Omics can be created via get_paginator() which returns a paginator object of type /AWS1/IF_OMX_PAGINATOR. The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using has_next() and get_next() methods.

Details about the paginator methods available for service Amazon Omics can be found in interface /AWS1/IF_OMX_PAGINATOR.