API for AWS Shield¶
| ABAP Package | /AWS1/API_SHD |
|---|---|
| ABAP SDK "TLA" | SHD |
| ABAP Interface | /AWS1/IF_SHD |
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 Shield is SHD.
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 Shield 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¶
This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the WAF and Shield Developer Guide.
Using the SDK¶
In your code, create a client using the SDK module for AWS Shield, which is created with
factory method /AWS1/CL_SHD_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_shd) = /aws1/cl_shd_factory=>create( go_session ).
Your variable go_shd is an instance of /AWS1/IF_SHD,
and all of the operations
in the AWS Shield service are accessed by calling methods in /AWS1/IF_SHD.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AWS Shield, see the Operation List.
Factory Method¶
/AWS1/CL_SHD_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_SHD.
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_shd /AWS1/IF_SHD¶
/AWS1/IF_SHDrepresents the ABAP client for the Shield service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_shd)->get_config( ).
lo_config is a variable of type /AWS1/CL_SHD_CONFIG. See the documentation for /AWS1/CL_SHD_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for AWS Shield can be created via get_paginator() which returns a paginator object of type /AWS1/IF_SHD_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 Shield can be found in interface /AWS1/IF_SHD_PAGINATOR.