API for AWS Transfer Family¶

ABAP Package	`/AWS1/API_TRN_IMPL`
ABAP SDK "TLA"	`TRN`
ABAP Interface	`/AWS1/IF_TRN`

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 Transfer Family is TRN. 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 Transfer 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¶

Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS. Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.

Using the SDK¶

In your code, create a client using the SDK module for AWS Transfer Family, which is created with factory method /AWS1/CL_TRN_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_trn)       = /aws1/cl_trn_factory=>create( go_session ).

Your variable go_trn is an instance of /AWS1/IF_TRN, and all of the operations in the AWS Transfer Family service are accessed by calling methods in /AWS1/IF_TRN.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_TRN.

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_TRN` `/AWS1/IF_TRN`¶

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

Configuring Programmatically¶

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

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

Waiters¶

Waiters for Implementation can be accessed via get_waiter() method followed by the waiter method to be called.

Details about the waiter methods available for service Implementation can be found in interface /AWS1/IF_TRN_WAITER.

Paginators¶

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