API for CloudWatch Observability Access Manager¶
| ABAP Package | /AWS1/API_OAM_IMPL |
|---|---|
| ABAP SDK "TLA" | OAM |
| ABAP Interface | /AWS1/IF_OAM |
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 CloudWatch Observability Access Manager is OAM.
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 OAM 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¶
Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, Application Signals services, service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.
Set up one or more Amazon Web Services accounts as monitoring accounts and link them with multiple source accounts. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services, service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors in CloudWatch Internet Monitor.
When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces. And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups.
Using the SDK¶
In your code, create a client using the SDK module for CloudWatch Observability Access Manager, which is created with
factory method /AWS1/CL_OAM_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_oam) = /aws1/cl_oam_factory=>create( go_session ).
Your variable go_oam is an instance of /AWS1/IF_OAM,
and all of the operations
in the CloudWatch Observability Access Manager service are accessed by calling methods in /AWS1/IF_OAM.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in CloudWatch Observability Access Manager, see the Operation List.
Factory Method¶
/AWS1/CL_OAM_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_OAM.
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_OAM /AWS1/IF_OAM¶
/AWS1/IF_OAMrepresents the ABAP client for the OAM service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_oam)->get_config( ).
lo_config is a variable of type /AWS1/CL_OAM_CONFIG. See the documentation for /AWS1/CL_OAM_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for CloudWatch Observability Access Manager can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_OAM_PAGINATOR`](./_AWS1_IF_OAM_PAGINATOR.md). 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 CloudWatch Observability Access Manager can be found in interface [`/AWS1/IF_OAM_PAGINATOR`](./_AWS1_IF_OAM_PAGINATOR.md).