API for Amazon CodeGuru Profiler¶

ABAP Package	`/AWS1/API_GUP_IMPL`
ABAP SDK "TLA"	`GUP`
ABAP Interface	`/AWS1/IF_GUP`

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 CodeGuru Profiler is GUP. 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 CodeGuruProfiler 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¶

This section provides documentation for the Amazon CodeGuru Profiler API operations.

Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides recommendations that can help you fine-tune your application performance. Using machine learning algorithms, CodeGuru Profiler can help you find your most expensive lines of code and suggest ways you can improve efficiency and remove CPU bottlenecks.

Amazon CodeGuru Profiler provides different visualizations of profiling data to help you identify what code is running on the CPU, see how much time is consumed, and suggest ways to reduce CPU utilization.

Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) languages and Python. While CodeGuru Profiler supports both visualizations and recommendations for applications written in Java, it can also generate visualizations and a subset of recommendations for applications written in other JVM languages and Python.

For more information, see What is Amazon CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide.

Using the SDK¶

In your code, create a client using the SDK module for Amazon CodeGuru Profiler, which is created with factory method /AWS1/CL_GUP_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_gup)       = /aws1/cl_gup_factory=>create( go_session ).

Your variable go_gup is an instance of /AWS1/IF_GUP, and all of the operations in the Amazon CodeGuru Profiler service are accessed by calling methods in /AWS1/IF_GUP.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_GUP.

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_GUP` `/AWS1/IF_GUP`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Amazon CodeGuru Profiler can be created via get_paginator() which returns a paginator object of type /AWS1/IF_GUP_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 CodeGuru Profiler can be found in interface /AWS1/IF_GUP_PAGINATOR.