API for AWS Parallel Computing Service¶

ABAP Package	`/AWS1/API_HPP_IMPL`
ABAP SDK "TLA"	`HPP`
ABAP Interface	`/AWS1/IF_HPP`

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 Parallel Computing Service is HPP. 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 PCS 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 Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for you to run and scale your high performance computing (HPC) workloads, and build scientific and engineering models on Amazon Web Services using Slurm. For more information, see the Amazon Web Services Parallel Computing Service User Guide.

This reference describes the actions and data types of the service management API. You can use the Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API actions manually. These API actions manage the service through an Amazon Web Services account.

The API actions operate on Amazon Web Services PCS resources. A resource is an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute node groups, and queues. For more information about resources in Amazon Web Services, see Resource in the Resource Explorer User Guide.

An Amazon Web Services PCS compute node is an Amazon EC2 instance. You don't launch compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources related to those compute nodes.

Using the SDK¶

In your code, create a client using the SDK module for AWS Parallel Computing Service, which is created with factory method /AWS1/CL_HPP_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_hpp)       = /aws1/cl_hpp_factory=>create( go_session ).

Your variable go_hpp is an instance of /AWS1/IF_HPP, and all of the operations in the AWS Parallel Computing Service service are accessed by calling methods in /AWS1/IF_HPP.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS Parallel Computing Service, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_HPP.

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_HPP` `/AWS1/IF_HPP`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS Parallel Computing Service can be created via get_paginator() which returns a paginator object of type /AWS1/IF_HPP_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 Parallel Computing Service can be found in interface /AWS1/IF_HPP_PAGINATOR.