API for CloudWatch Observability Admin Service¶
| ABAP Package | /AWS1/API_CWO |
|---|---|
| ABAP SDK "TLA" | CWO |
| ABAP Interface | /AWS1/IF_CWO |
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 Admin Service is CWO.
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 ObservabilityAdmin 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¶
You can use Amazon CloudWatch Observability Admin to discover and understand the state of telemetry configuration in CloudWatch for your Amazon Web Services Organization or account. This simplifies the process of auditing your telemetry collection configurations across multiple resource types within your Amazon Web Services Organization or account. By providing a consolidated view, it allows you to easily review and manage telemetry settings, helping you ensure proper monitoring and data collection across your Amazon Web Services environment. For more information, see Auditing CloudWatch telemetry configurations in the CloudWatch User Guide.
For information on the permissions you need to use this API, see Identity and access management for Amazon CloudWatch in the CloudWatch User Guide.
Using the SDK¶
In your code, create a client using the SDK module for CloudWatch Observability Admin Service, which is created with
factory method /AWS1/CL_CWO_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_cwo) = /aws1/cl_cwo_factory=>create( go_session ).
Your variable go_cwo is an instance of /AWS1/IF_CWO,
and all of the operations
in the CloudWatch Observability Admin Service service are accessed by calling methods in /AWS1/IF_CWO.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in CloudWatch Observability Admin Service, see the Operation List.
Factory Method¶
/AWS1/CL_CWO_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_CWO.
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_cwo /AWS1/IF_CWO¶
/AWS1/IF_CWOrepresents the ABAP client for the ObservabilityAdmin service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_cwo)->get_config( ).
lo_config is a variable of type /AWS1/CL_CWO_CONFIG. See the documentation for /AWS1/CL_CWO_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for CloudWatch Observability Admin Service can be created via get_paginator() which returns a paginator object of type /AWS1/IF_CWO_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 CloudWatch Observability Admin Service can be found in interface /AWS1/IF_CWO_PAGINATOR.