Skip to content

API for AWS Backup Gateway

ABAP Package /AWS1/API_BUG_IMPL
ABAP SDK "TLA" BUG
ABAP Interface /AWS1/IF_BUG

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 Backup Gateway is BUG. 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 Backup Gateway 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

Backup gateway

Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere, whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services.

Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.

Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand backups. Once you have backed up your resources, you can view them and restore them like any resource supported by Backup.

To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.

Using the SDK

In your code, create a client using the SDK module for AWS Backup Gateway, which is created with factory method /AWS1/CL_BUG_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_bug)       = /aws1/cl_bug_factory=>create( go_session ).

Your variable go_bug is an instance of /AWS1/IF_BUG, and all of the operations in the AWS Backup Gateway service are accessed by calling methods in /AWS1/IF_BUG.

API Operations

For an overview of ABAP method calls corresponding to API operations in AWS Backup Gateway, see the Operation List.

Factory Method

/AWS1/CL_BUG_FACTORY=>create( )

Creates an object of type /AWS1/IF_BUG.

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_BUG

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

Configuring Programmatically

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

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

Paginators

Paginators for AWS Backup Gateway can be created via get_paginator() which returns a paginator object of type /AWS1/IF_BUG_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 Backup Gateway can be found in interface /AWS1/IF_BUG_PAGINATOR.