API for AWS DataSync¶

ABAP Package	`/AWS1/API_DSY_IMPL`
ABAP SDK "TLA"	`DSY`
ABAP Interface	`/AWS1/IF_DSY`

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 DataSync is DSY. 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 DataSync 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¶

DataSync

DataSync is an online data movement and discovery service that simplifies data migration and helps you quickly, easily, and securely transfer your file or object data to, from, and between Amazon Web Services storage services.

This API interface reference includes documentation for using DataSync programmatically. For complete information, see the DataSync User Guide .

Using the SDK¶

In your code, create a client using the SDK module for AWS DataSync, which is created with factory method /AWS1/CL_DSY_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_dsy)       = /aws1/cl_dsy_factory=>create( go_session ).

Your variable go_dsy is an instance of /AWS1/IF_DSY, and all of the operations in the AWS DataSync service are accessed by calling methods in /AWS1/IF_DSY.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_DSY.

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_DSY` `/AWS1/IF_DSY`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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