API for Amazon Elastic Block Store¶

ABAP Package	`/AWS1/API_EBS_IMPL`
ABAP SDK "TLA"	`EBS`
ABAP Interface	`/AWS1/IF_EBS`

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 Elastic Block Store is EBS. 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 EBS 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¶

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to your snapshots, read data on your snapshots, and identify the differences or changes between two snapshots. If you’re an independent software vendor (ISV) who offers backup services for Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on your Amazon EBS volumes through snapshots. This can be done without having to create new volumes from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.

You can create incremental snapshots directly from data on-premises into volumes and the cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can write your on-premises data to an snapshot during a disaster. Then after recovery, you can restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and maintain complex mechanisms to copy data to and from Amazon EBS.

This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in the Amazon Web Services General Reference.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Elastic Block Store, which is created with factory method /AWS1/CL_EBS_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_ebs)       = /aws1/cl_ebs_factory=>create( go_session ).

Your variable go_ebs is an instance of /AWS1/IF_EBS, and all of the operations in the Amazon Elastic Block Store service are accessed by calling methods in /AWS1/IF_EBS.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_EBS.

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_EBS` `/AWS1/IF_EBS`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Amazon Elastic Block Store can be created via get_paginator() which returns a paginator object of type /AWS1/IF_EBS_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 Elastic Block Store can be found in interface /AWS1/IF_EBS_PAGINATOR.