API for Amazon Managed Grafana¶
| ABAP Package | /AWS1/API_GRF_IMPL |
|---|---|
| ABAP SDK "TLA" | GRF |
| ABAP Interface | /AWS1/IF_GRF |
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 Amazon Managed Grafana is GRF.
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 grafana 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 Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.
With Amazon Managed Grafana, you create logically isolated Grafana servers called workspaces. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers.
Using the SDK¶
In your code, create a client using the SDK module for Amazon Managed Grafana, which is created with
factory method /AWS1/CL_GRF_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_grf) = /aws1/cl_grf_factory=>create( go_session ).
Your variable go_grf is an instance of /AWS1/IF_GRF,
and all of the operations
in the Amazon Managed Grafana service are accessed by calling methods in /AWS1/IF_GRF.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon Managed Grafana, see the Operation List.
Factory Method¶
/AWS1/CL_GRF_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_GRF.
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_grf /AWS1/IF_GRF¶
/AWS1/IF_GRFrepresents the ABAP client for the grafana service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_grf)->get_config( ).
lo_config is a variable of type /AWS1/CL_GRF_CONFIG. See the documentation for /AWS1/CL_GRF_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon Managed Grafana can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_GRF_PAGINATOR`](./_AWS1_IF_GRF_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 Amazon Managed Grafana can be found in interface [`/AWS1/IF_GRF_PAGINATOR`](./_AWS1_IF_GRF_PAGINATOR.md).