API for Redshift Data API Service¶

ABAP Package	`/AWS1/API_RSD_IMPL`
ABAP SDK "TLA"	`RSD`
ABAP Interface	`/AWS1/IF_RSD`

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 Redshift Data API Service is RSD. 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 Redshift Data 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¶

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Using the SDK¶

In your code, create a client using the SDK module for Redshift Data API Service, which is created with factory method /AWS1/CL_RSD_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_rsd)       = /aws1/cl_rsd_factory=>create( go_session ).

Your variable go_rsd is an instance of /AWS1/IF_RSD, and all of the operations in the Redshift Data API Service service are accessed by calling methods in /AWS1/IF_RSD.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in Redshift Data API Service, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_RSD.

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_RSD` `/AWS1/IF_RSD`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Redshift Data API Service can be created via get_paginator() which returns a paginator object of type /AWS1/IF_RSD_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 Redshift Data API Service can be found in interface /AWS1/IF_RSD_PAGINATOR.