API for Firewall Management Service¶

ABAP Package	`/AWS1/API_FMS_IMPL`
ABAP SDK "TLA"	`FMS`
ABAP Interface	`/AWS1/IF_FMS`

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 Firewall Management Service is FMS. 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 FMS 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 Firewall Manager API Reference. This guide is for developers who need detailed information about the Firewall Manager API actions, data types, and errors. For detailed information about Firewall Manager features, see the Firewall Manager Developer Guide.

Some API actions require explicit resource permissions. For information, see the developer guide topic Service roles for Firewall Manager.

Using the SDK¶

In your code, create a client using the SDK module for Firewall Management Service, which is created with factory method /AWS1/CL_FMS_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_fms)       = /aws1/cl_fms_factory=>create( go_session ).

Your variable go_fms is an instance of /AWS1/IF_FMS, and all of the operations in the Firewall Management Service service are accessed by calling methods in /AWS1/IF_FMS.

API Operations¶

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

Factory Method¶

`/AWS1/CL_FMS_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_FMS.

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_FMS` `/AWS1/IF_FMS`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Firewall Management Service can be created via get_paginator() which returns a paginator object of type /AWS1/IF_FMS_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 Firewall Management Service can be found in interface /AWS1/IF_FMS_PAGINATOR.