API for Amazon WorkSpaces¶
|ABAP SDK "TLA"||
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
This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.
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 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
In this example we will assume you have configured
an SDK profile in transaction
DATA(go_session) = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ). DATA(go_wsp) = /aws1/cl_wsp_factory=>create( go_session ).
For an overview of ABAP method calls corresponding to API operations in Amazon WorkSpaces, see the Operation List.
Creates an object of type
TYPE REF TO
TYPE REF TO
/AWS1/IF_WSPrepresents the ABAP client for the WorkSpaces service, representing each operation as a method call. For more information see the API Page page.
DATA(lo_config) = DATA(go_wsp)->get_config( ).
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
Details about the paginator methods available for service Amazon WorkSpaces can be found in interface