API for AWS Network Security Manager Customer API¶
| ABAP Package | /AWS1/API_NWS |
|---|---|
| ABAP SDK "TLA" | NWS |
| ABAP Interface | /AWS1/IF_NWS |
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 Network Security Manager Customer API is NWS.
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 Network Security Manager 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¶
AWS Network Security Manager helps you centrally configure and deploy network security protections across your organization. Supported protections include AWS WAF and AWS Shield Advanced. This centralized approach reduces the overhead of managing protections individually across accounts and ensures consistent security at scale.
You define reusable rules and templates, then combine them into policies. Next, you select the accounts and resources to protect with scopes and roll the protections out with deployments. For example, you can define a set of AWS WAF rules and group them into a policy. Then deploy that policy across all accounts in your organization with a single deployment.
This API reference describes the operations and data types for AWS Network Security Manager.
For conceptual information, tutorials, and guidance on writing rule configurations, see the AWS Network Security Manager Developer Guide. For the default quotas that apply to your account, see Quotas. For the service endpoints available in each Region, see AWS Network Security Manager endpoints and quotas in the AWS General Reference.
Using the SDK¶
In your code, create a client using the SDK module for AWS Network Security Manager Customer API, which is created with
factory method /AWS1/CL_NWS_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_nws) = /aws1/cl_nws_factory=>create( go_session ).
Your variable go_nws is an instance of /AWS1/IF_NWS,
and all of the operations
in the AWS Network Security Manager Customer API service are accessed by calling methods in /AWS1/IF_NWS.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AWS Network Security Manager Customer API, see the Operation List.
Factory Method¶
/AWS1/CL_NWS_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_NWS.
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_nws /AWS1/IF_NWS¶
/AWS1/IF_NWSrepresents the ABAP client for the Network Security Manager service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_nws)->get_config( ).
lo_config is a variable of type /AWS1/CL_NWS_CONFIG. See the documentation for /AWS1/CL_NWS_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for AWS Network Security Manager Customer API can be created via get_paginator() which returns a paginator object of type /AWS1/IF_NWS_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 Network Security Manager Customer API can be found in interface /AWS1/IF_NWS_PAGINATOR.