API for Redshift Serverless¶

ABAP Package	`/AWS1/API_RSS_IMPL`
ABAP SDK "TLA"	`RSS`
ABAP Interface	`/AWS1/IF_RSS`

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 Serverless is RSS. 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 Serverless 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 an interface reference for Amazon Redshift Serverless. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless.

Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you focus on using your data to acquire new insights for your business and customers.

To learn more about Amazon Redshift Serverless, see What is Amazon Redshift Serverless.

Using the SDK¶

In your code, create a client using the SDK module for Redshift Serverless, which is created with factory method /AWS1/CL_RSS_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_rss)       = /aws1/cl_rss_factory=>create( go_session ).

Your variable go_rss is an instance of /AWS1/IF_RSS, and all of the operations in the Redshift Serverless service are accessed by calling methods in /AWS1/IF_RSS.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_RSS.

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_RSS` `/AWS1/IF_RSS`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Redshift Serverless can be created via get_paginator() which returns a paginator object of type /AWS1/IF_RSS_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 Serverless can be found in interface /AWS1/IF_RSS_PAGINATOR.