Skip to content

API for AWS Performance Insights

ABAP Package /AWS1/API_PIE_IMPL
ABAP SDK "TLA" PIE
ABAP Interface /AWS1/IF_PIE

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 Performance Insights is PIE. 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 PI 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 RDS Performance Insights

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.

When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.

DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

Using the SDK

In your code, create a client using the SDK module for AWS Performance Insights, which is created with factory method /AWS1/CL_PIE_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_pie)       = /aws1/cl_pie_factory=>create( go_session ).

Your variable go_pie is an instance of /AWS1/IF_PIE, and all of the operations in the AWS Performance Insights service are accessed by calling methods in /AWS1/IF_PIE.

API Operations

For an overview of ABAP method calls corresponding to API operations in AWS Performance Insights, see the Operation List.

Factory Method

/AWS1/CL_PIE_FACTORY=>create( )

Creates an object of type /AWS1/IF_PIE.

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_PIE /AWS1/IF_PIE

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

Configuring Programmatically

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

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

Paginators

Paginators for AWS Performance Insights can be created via get_paginator() which returns a paginator object of type /AWS1/IF_PIE_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 Performance Insights can be found in interface /AWS1/IF_PIE_PAGINATOR.