API for Amazon Recycle Bin¶

ABAP Package	`/AWS1/API_RBN_IMPL`
ABAP SDK "TLA"	`RBN`
ABAP Interface	`/AWS1/IF_RBN`

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 Recycle Bin is RBN. 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 rbin 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 is the Recycle Bin API Reference. This documentation provides descriptions and syntax for each of the actions and data types in Recycle Bin.

Recycle Bin is a resource recovery feature that enables you to restore accidentally deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are deleted, they are retained in the Recycle Bin for a time period that you specify.

You can restore a resource from the Recycle Bin at any time before its retention period expires. After you restore a resource from the Recycle Bin, the resource is removed from the Recycle Bin, and you can then use it in the same way you use any other resource of that type in your account. If the retention period expires and the resource is not restored, the resource is permanently deleted from the Recycle Bin and is no longer available for recovery. For more information about Recycle Bin, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Recycle Bin, which is created with factory method /AWS1/CL_RBN_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_rbn)       = /aws1/cl_rbn_factory=>create( go_session ).

Your variable go_rbn is an instance of /AWS1/IF_RBN, and all of the operations in the Amazon Recycle Bin service are accessed by calling methods in /AWS1/IF_RBN.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_RBN.

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_RBN` `/AWS1/IF_RBN`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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