API for Amazon WorkSpaces

ABAP Package	/AWS1/API_WSP_IMPL
ABAP SDK "TLA"	WSP
ABAP Interface	/AWS1/IF_WSP

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 WorkSpaces is WSP. 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 WorkSpaces 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 WorkSpaces Service

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.

You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.

Using the SDK

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

Your variable go_wsp is an instance of /AWS1/IF_WSP, and all of the operations in the Amazon WorkSpaces service are accessed by calling methods in /AWS1/IF_WSP.

API Operations

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

Factory Method

/AWS1/CL_WSP_FACTORY=>create( )

Creates an object of type /AWS1/IF_WSP.

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_WSP /AWS1/IF_WSP

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

Configuring Programmatically

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

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

Paginators

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