Skip to content

API for AWS AppConfig Data

ABAP Package /AWS1/API_APD_IMPL
ABAP SDK "TLA" APD
ABAP Interface /AWS1/IF_APD

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 AppConfig Data is APD. 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 AppConfigData 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

AppConfig Data provides the data plane APIs your application uses to retrieve configuration data. Here's how it works:

Your application retrieves configuration data by first establishing a configuration session using the AppConfig Data StartConfigurationSession API action. Your session's client then makes periodic calls to GetLatestConfiguration to check for and retrieve the latest data available.

When calling StartConfigurationSession, your code sends the following information:

  • Identifiers (ID or name) of an AppConfig application, environment, and configuration profile that the session tracks.

  • (Optional) The minimum amount of time the session's client must wait between calls to GetLatestConfiguration.

In response, AppConfig provides an InitialConfigurationToken to be given to the session's client and used the first time it calls GetLatestConfiguration for that session.

This token should only be used once in your first call to GetLatestConfiguration. You must use the new token in the GetLatestConfiguration response (NextPollConfigurationToken) in each subsequent call to GetLatestConfiguration.

When calling GetLatestConfiguration, your client code sends the most recent ConfigurationToken value it has and receives in response:

  • NextPollConfigurationToken: the ConfigurationToken value to use on the next call to GetLatestConfiguration.

  • NextPollIntervalInSeconds: the duration the client should wait before making its next call to GetLatestConfiguration. This duration may vary over the course of the session, so it should be used instead of the value sent on the StartConfigurationSession call.

  • The configuration: the latest data intended for the session. This may be empty if the client already has the latest version of the configuration.

The InitialConfigurationToken and NextPollConfigurationToken should only be used once. To support long poll use cases, the tokens are valid for up to 24 hours. If a GetLatestConfiguration call uses an expired token, the system returns BadRequestException.

For more information and to view example CLI commands that show how to retrieve a configuration using the AppConfig Data StartConfigurationSession and GetLatestConfiguration API actions, see Retrieving the configuration in the AppConfig User Guide.

Using the SDK

In your code, create a client using the SDK module for AWS AppConfig Data, which is created with factory method /AWS1/CL_APD_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_apd)       = /aws1/cl_apd_factory=>create( go_session ).

Your variable go_apd is an instance of /AWS1/IF_APD, and all of the operations in the AWS AppConfig Data service are accessed by calling methods in /AWS1/IF_APD.

API Operations

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

Factory Method

/AWS1/CL_APD_FACTORY=>create( )

Creates an object of type /AWS1/IF_APD.

IMPORTING

Optional arguments:

IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL /AWS1/RT_PROTOCOL

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE /AWS1/CL_RT_SESSION_BASE

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

IV_REGION TYPE /AWS1/RT_REGION_ID /AWS1/RT_REGION_ID

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT /AWS1/RT_ENDPOINT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

RETURNING

OO_CLIENT TYPE REF TO /AWS1/IF_APD /AWS1/IF_APD

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

Configuring Programmatically

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

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