API for Amazon Athena

ABAP Package	/AWS1/API_ATH_IMPL
ABAP SDK "TLA"	ATH
ABAP Interface	/AWS1/IF_ATH

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 Athena is ATH. 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 Athena 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 Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see What is Amazon Athena in the Amazon Athena User Guide.

If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC.

Using the SDK

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

Your variable go_ath is an instance of /AWS1/IF_ATH, and all of the operations in the Amazon Athena service are accessed by calling methods in /AWS1/IF_ATH.

API Operations

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

Factory Method

/AWS1/CL_ATH_FACTORY=>create( )

Creates an object of type /AWS1/IF_ATH.

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_ATH /AWS1/IF_ATH

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

Configuring Programmatically

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

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

Paginators

Paginators for Amazon Athena can be created via get_paginator() which returns a paginator object of type /AWS1/IF_ATH_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 Athena can be found in interface /AWS1/IF_ATH_PAGINATOR.