API for Amazon API Gateway¶
ABAP Package | /AWS1/API_AGW_IMPL |
---|---|
ABAP SDK "TLA" | AGW |
ABAP Interface | /AWS1/IF_AGW |
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 API Gateway is AGW
.
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 API Gateway 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 API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
Using the SDK¶
In your code, create a client using the SDK module for Amazon API Gateway, which is created with
factory method /AWS1/CL_AGW_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_agw) = /aws1/cl_agw_factory=>create( go_session ).
Your variable go_agw
is an instance of /AWS1/IF_AGW
,
and all of the operations
in the Amazon API Gateway service are accessed by calling methods in /AWS1/IF_AGW
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon API Gateway, see the Operation List.
Factory Method¶
/AWS1/CL_AGW_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_AGW
.
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_AGW
/AWS1/IF_AGW
¶
/AWS1/IF_AGW
represents the ABAP client for the API Gateway service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_agw)->get_config( ).
lo_config
is a variable of type /AWS1/CL_AGW_CONFIG
. See the documentation for /AWS1/CL_AGW_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon API Gateway can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_AGW_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 API Gateway can be found in interface /AWS1/IF_AGW_PAGINATOR
.