API for AWS Data Exchange¶

ABAP Package	`/AWS1/API_DEX_IMPL`
ABAP SDK "TLA"	`DEX`
ABAP Interface	`/AWS1/IF_DEX`

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 Data Exchange is DEX. 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 DataExchange 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¶

AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.

As a subscriber, you can view and access the data sets that you have an entitlement to through a subscription. You can use the APIs to download or copy your entitled data sets to Amazon Simple Storage Service (Amazon S3) for use across a variety of AWS analytics and machine learning services.

As a provider, you can create and manage your data sets that you would like to publish to a product. Being able to package and provide your data sets into products requires a few steps to determine eligibility. For more information, visit the AWS Data Exchange User Guide.

A data set is a collection of data that can be changed or updated over time. Data sets can be updated using revisions, which represent a new version or incremental change to a data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data that can be stored as an Amazon S3 object, Redshift datashare, API Gateway API, AWS Lake Formation data permission, or Amazon S3 data access. The asset can be a structured data file, an image file, or some other data file. Jobs are asynchronous import or export operations used to create or copy assets.

Using the SDK¶

In your code, create a client using the SDK module for AWS Data Exchange, which is created with factory method /AWS1/CL_DEX_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_dex)       = /aws1/cl_dex_factory=>create( go_session ).

Your variable go_dex is an instance of /AWS1/IF_DEX, and all of the operations in the AWS Data Exchange service are accessed by calling methods in /AWS1/IF_DEX.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_DEX.

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_DEX` `/AWS1/IF_DEX`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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