Skip to content

API for AmazonApiGatewayManagementApi

ABAP Package /AWS1/API_AGM_IMPL
ABAP SDK "TLA" AGM
ABAP Interface /AWS1/IF_AGM

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 AmazonApiGatewayManagementApi is AGM. 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 ApiGatewayManagementApi 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 API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

Using the SDK

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

Your variable go_agm is an instance of /AWS1/IF_AGM, and all of the operations in the AmazonApiGatewayManagementApi service are accessed by calling methods in /AWS1/IF_AGM.

API Operations

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

Factory Method

/AWS1/CL_AGM_FACTORY=>create( )

Creates an object of type /AWS1/IF_AGM.

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_AGM

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

Configuring Programmatically

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

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