API for QApps¶

ABAP Package	`/AWS1/API_QQA_IMPL`
ABAP SDK "TLA"	`QQA`
ABAP Interface	`/AWS1/IF_QQA`

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 QApps is QQA. 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 QApps 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¶

The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create an Q Appthat exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for marketing content-generation like writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information, see Amazon Q App in the Amazon Q Business User Guide.

Using the SDK¶

In your code, create a client using the SDK module for QApps, which is created with factory method /AWS1/CL_QQA_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_qqa)       = /aws1/cl_qqa_factory=>create( go_session ).

Your variable go_qqa is an instance of /AWS1/IF_QQA, and all of the operations in the QApps service are accessed by calling methods in /AWS1/IF_QQA.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_QQA.

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_QQA` `/AWS1/IF_QQA`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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