API for AppFabric¶
ABAP Package | /AWS1/API_AFC_IMPL |
---|---|
ABAP SDK "TLA" | AFC |
ABAP Interface | /AWS1/IF_AFC |
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 AppFabric is AFC
.
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 AppFabric 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 Web Services AppFabric quickly connects software as a service (SaaS) applications across your organization. This allows IT and security teams to easily manage and secure applications using a standard schema, and employees can complete everyday tasks faster using generative artificial intelligence (AI). You can use these APIs to complete AppFabric tasks, such as setting up audit log ingestions or viewing user access. For more information about AppFabric, including the required permissions to use the service, see the Amazon Web Services AppFabric Administration Guide. For more information about using the Command Line Interface (CLI) to manage your AppFabric resources, see the AppFabric section of the CLI Reference.
Using the SDK¶
In your code, create a client using the SDK module for AppFabric, which is created with
factory method /AWS1/CL_AFC_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_afc) = /aws1/cl_afc_factory=>create( go_session ).
Your variable go_afc
is an instance of /AWS1/IF_AFC
,
and all of the operations
in the AppFabric service are accessed by calling methods in /AWS1/IF_AFC
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AppFabric, see the Operation List.
Factory Method¶
/AWS1/CL_AFC_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_AFC
.
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_AFC
/AWS1/IF_AFC
¶
/AWS1/IF_AFC
represents the ABAP client for the AppFabric service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_afc)->get_config( ).
lo_config
is a variable of type /AWS1/CL_AFC_CONFIG
. See the documentation for /AWS1/CL_AFC_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for AppFabric can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_AFC_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 AppFabric can be found in interface /AWS1/IF_AFC_PAGINATOR
.