API for Amazon Prometheus Service¶

ABAP Package	`/AWS1/API_AMP_IMPL`
ABAP SDK "TLA"	`AMP`
ABAP Interface	`/AWS1/IF_AMP`

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 Prometheus Service is AMP. 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 amp 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 Service for Prometheus is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor container environments at scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data model and query language that you use today to monitor the performance of your containerized workloads, and also enjoy improved scalability, availability, and security without having to manage the underlying infrastructure.

For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.

Amazon Managed Service for Prometheus includes two APIs.

Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert managers.
Use the Prometheus-compatible API to work within your Prometheus workspace.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Prometheus Service, which is created with factory method /AWS1/CL_AMP_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_amp)       = /aws1/cl_amp_factory=>create( go_session ).

Your variable go_amp is an instance of /AWS1/IF_AMP, and all of the operations in the Amazon Prometheus Service service are accessed by calling methods in /AWS1/IF_AMP.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in Amazon Prometheus Service, see the Operation List.

Factory Method¶

`/AWS1/CL_AMP_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_AMP.

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_AMP` `/AWS1/IF_AMP`¶

/AWS1/IF_AMP represents the ABAP client for the amp service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically¶

DATA(lo_config) = DATA(go_amp)->get_config( ).

lo_config is a variable of type /AWS1/CL_AMP_CONFIG. See the documentation for /AWS1/CL_AMP_CONFIG for details on the settings that can be configured.

Waiters¶

Waiters for Implementation can be accessed via get_waiter() method followed by the waiter method to be called.

Details about the waiter methods available for service Implementation can be found in interface /AWS1/IF_AMP_WAITER.

Paginators¶

Paginators for Amazon Prometheus Service can be created via get_paginator() which returns a paginator object of type /AWS1/IF_AMP_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 Amazon Prometheus Service can be found in interface /AWS1/IF_AMP_PAGINATOR.