API for Amazon Simple Storage Service¶

ABAP Package	`/AWS1/API_S3`
ABAP SDK "TLA"	`S3`
ABAP Interface	`/AWS1/IF_S3`

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 Simple Storage Service is S3. 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 S3 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¶

For information about using the Amazon S3 API—including authentication, signing requests, code examples, and error handling—see the Amazon S3 Developer Guide.

Welcome to the Amazon S3 API Reference. This guide explains the Amazon Simple Storage Service (Amazon S3) application programming interface (API).

You can use any toolkit that supports HTTP to use the REST API. You can even use a browser to fetch objects, as long as they are anonymously readable.

The REST API uses the standard HTTP headers and status codes, so that standard browsers and toolkits work as expected. In some areas, we have added functionality to HTTP (for example, we added headers to support access control). In these cases, we have done our best to add the new functionality in a way that matched the style of standard HTTP usage.

The current version of the Amazon S3 API is 2006-03-01.

Amazon S3 supports the REST API.

Support for SOAP over HTTP is deprecated, but it is still available over HTTPS. However, new Amazon S3 features will not be supported for SOAP. We recommend that you use either this REST API or the Amazon Web Services SDKs.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Simple Storage Service, which is created with factory method /AWS1/CL_S3_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_s3)       = /aws1/cl_s3_factory=>create( go_session ).

Your variable go_s3 is an instance of /AWS1/IF_S3, and all of the operations in the Amazon Simple Storage Service service are accessed by calling methods in /AWS1/IF_S3.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in Amazon Simple Storage Service, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_S3.

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_s3` `/AWS1/IF_S3`¶

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

Configuring Programmatically¶

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

lo_config is a variable of type /AWS1/CL_S3_CONFIG. See the documentation for /AWS1/CL_S3_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_S3_WAITER.

Paginators¶

Paginators for Amazon Simple Storage Service can be created via get_paginator() which returns a paginator object of type /AWS1/IF_S3_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 Simple Storage Service can be found in interface /AWS1/IF_S3_PAGINATOR.

Presigner¶

/AWS1/IF_S3_PRESIGNER represents the Presigner client for Amazon Simple Storage Service.

You can use presigned URLs to grant time-limited access to AWS services. A presigned URL can be entered in a browser or used by a program to perform the service operation. The credentials used by the presigned URL are those of the AWS Identity and Access Management (IAM) principal who generated the URL. You can use the presigned URL multiple times, up to the expiration date and time.

Create a presigner using the GET_PRESIGNER() method of the API client. Then call a method of the presigner, which correspond to the methods of the API client, except they return a presigned URL instead of actually performing the operation.