API for Amazon WorkDocs¶

ABAP Package	`/AWS1/API_WDX_IMPL`
ABAP SDK "TLA"	`WDX`
ABAP Interface	`/AWS1/IF_WDX`

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 WorkDocs is WDX. 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 WorkDocs 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¶

The Amazon WorkDocs API is designed for the following use cases:

File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.
Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.
eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.

All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.

The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:

READ (Get*)
WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)
LIST (Describe*)
DELETE*, CANCEL

For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing.

Using the SDK¶

In your code, create a client using the SDK module for Amazon WorkDocs, which is created with factory method /AWS1/CL_WDX_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_wdx)       = /aws1/cl_wdx_factory=>create( go_session ).

Your variable go_wdx is an instance of /AWS1/IF_WDX, and all of the operations in the Amazon WorkDocs service are accessed by calling methods in /AWS1/IF_WDX.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_WDX.

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_WDX` `/AWS1/IF_WDX`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Amazon WorkDocs can be created via get_paginator() which returns a paginator object of type /AWS1/IF_WDX_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 WorkDocs can be found in interface /AWS1/IF_WDX_PAGINATOR.