API for Amazon Neptune¶

ABAP Package	`/AWS1/API_NEP_IMPL`
ABAP SDK "TLA"	`NEP`
ABAP Interface	`/AWS1/IF_NEP`

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 Neptune is NEP. 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 Neptune 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 Neptune

Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security.

This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Neptune, which is created with factory method /AWS1/CL_NEP_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_nep)       = /aws1/cl_nep_factory=>create( go_session ).

Your variable go_nep is an instance of /AWS1/IF_NEP, and all of the operations in the Amazon Neptune service are accessed by calling methods in /AWS1/IF_NEP.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_NEP.

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_NEP` `/AWS1/IF_NEP`¶

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

Configuring Programmatically¶

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

lo_config is a variable of type /AWS1/CL_NEP_CONFIG. See the documentation for /AWS1/CL_NEP_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_NEP_WAITER.

Paginators¶

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