Skip to content

API for AWS Amplify UI Builder

ABAP Package /AWS1/API_AMU_IMPL
ABAP SDK "TLA" AMU
ABAP Interface /AWS1/IF_AMU

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 AWS Amplify UI Builder is AMU. 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 AmplifyUIBuilder 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 Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources.

You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see Introduction in the Amplify Docs.

The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. For more information about deploying an Amplify application to Amazon Web Services, see the Amplify User Guide.

Using the SDK

In your code, create a client using the SDK module for AWS Amplify UI Builder, which is created with factory method /AWS1/CL_AMU_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_amu)       = /aws1/cl_amu_factory=>create( go_session ).

Your variable go_amu is an instance of /AWS1/IF_AMU, and all of the operations in the AWS Amplify UI Builder service are accessed by calling methods in /AWS1/IF_AMU.

API Operations

For an overview of ABAP method calls corresponding to API operations in AWS Amplify UI Builder, see the Operation List.

Factory Method

/AWS1/CL_AMU_FACTORY=>create( )

Creates an object of type /AWS1/IF_AMU.

IMPORTING

Optional arguments:

IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL

IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE

IV_REGION TYPE /AWS1/RT_REGION_ID

IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT

RETURNING

OO_CLIENT TYPE REF TO /AWS1/IF_AMU

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

Configuring Programmatically

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

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

Paginators

Paginators for AWS Amplify UI Builder can be created via get_paginator() which returns a paginator object of type /AWS1/IF_AMU_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 AWS Amplify UI Builder can be found in interface /AWS1/IF_AMU_PAGINATOR.