Skip to content

API for Amazon CodeGuru Reviewer

ABAP Package /AWS1/API_GUR_IMPL
ABAP SDK "TLA" GUR
ABAP Interface /AWS1/IF_GUR

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 Reviewer is GUR. 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 CodeGuru Reviewer 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 Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java and Python code.

By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide.

To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by creating an interface VPC endpoint. For more information, see CodeGuru Reviewer and interface VPC endpoints (Amazon Web Services PrivateLink) in the Amazon CodeGuru Reviewer User Guide.

Using the SDK

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

Your variable go_gur is an instance of /AWS1/IF_GUR, and all of the operations in the Amazon CodeGuru Reviewer service are accessed by calling methods in /AWS1/IF_GUR.

API Operations

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

Factory Method

/AWS1/CL_GUR_FACTORY=>create( )

Creates an object of type /AWS1/IF_GUR.

IMPORTING

Optional arguments:

IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL

IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE

IV_REGION TYPE /AWS1/RT_REGION_ID

IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT

RETURNING

OO_CLIENT TYPE REF TO /AWS1/IF_GUR

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

Configuring Programmatically

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

lo_config is a variable of type /AWS1/CL_GUR_CONFIG. See the documentation for /AWS1/CL_GUR_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_GUR_WAITER.

Paginators

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