API for AWS Audit Manager¶
ABAP Package | /AWS1/API_AUM_IMPL |
---|---|
ABAP SDK "TLA" | AUM |
ABAP Interface | /AWS1/IF_AUM |
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 Audit Manager is AUM
.
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 AuditManager 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¶
Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
Audit Manager is a service that provides automated evidence collection so that you can continually audit your Amazon Web Services usage. You can use it to assess the effectiveness of your controls, manage risk, and simplify compliance.
Audit Manager provides prebuilt frameworks that structure and automate assessments for a given compliance standard. Frameworks include a prebuilt collection of controls with descriptions and testing procedures. These controls are grouped according to the requirements of the specified compliance standard or regulation. You can also customize frameworks and controls to support internal audits with specific requirements.
Use the following links to get started with the Audit Manager API:
-
Actions: An alphabetical list of all Audit Manager API operations.
-
Data types: An alphabetical list of all Audit Manager data types.
-
Common parameters: Parameters that all operations can use.
-
Common errors: Client and server errors that all operations can return.
If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.
Using the SDK¶
In your code, create a client using the SDK module for AWS Audit Manager, which is created with
factory method /AWS1/CL_AUM_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_aum) = /aws1/cl_aum_factory=>create( go_session ).
Your variable go_aum
is an instance of /AWS1/IF_AUM
,
and all of the operations
in the AWS Audit Manager service are accessed by calling methods in /AWS1/IF_AUM
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AWS Audit Manager, see the Operation List.
Factory Method¶
/AWS1/CL_AUM_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_AUM
.
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_AUM
/AWS1/IF_AUM
¶
/AWS1/IF_AUM
represents the ABAP client for the AuditManager service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_aum)->get_config( ).
lo_config
is a variable of type /AWS1/CL_AUM_CONFIG
. See the documentation for /AWS1/CL_AUM_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for AWS Audit Manager can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_AUM_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 Audit Manager can be found in interface /AWS1/IF_AUM_PAGINATOR
.