API for Amazon QuickSight¶

ABAP Package	`/AWS1/API_QST_IMPL`
ABAP SDK "TLA"	`QST`
ABAP Interface	`/AWS1/IF_QST`

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 QuickSight is QST. 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 QuickSight 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 QuickSight API Reference

Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

Using the SDK¶

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

Your variable go_qst is an instance of /AWS1/IF_QST, and all of the operations in the Amazon QuickSight service are accessed by calling methods in /AWS1/IF_QST.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_QST.

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_QST`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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