API for Amazon Elastic File System¶

ABAP Package	`/AWS1/API_EFS_IMPL`
ABAP SDK "TLA"	`EFS`
ABAP Interface	`/AWS1/IF_EFS`

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 File System is EFS. 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 EFS 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¶

Amazon Elastic File System

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so that your applications have the storage they need, when they need it. For more information, see the Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Elastic File System, which is created with factory method /AWS1/CL_EFS_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_efs)       = /aws1/cl_efs_factory=>create( go_session ).

Your variable go_efs is an instance of /AWS1/IF_EFS, and all of the operations in the Amazon Elastic File System service are accessed by calling methods in /AWS1/IF_EFS.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_EFS.

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_EFS` `/AWS1/IF_EFS`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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