API for Amazon WorkSpaces Thin Client¶
ABAP Package | /AWS1/API_WST_IMPL |
---|---|
ABAP SDK "TLA" | WST |
ABAP Interface | /AWS1/IF_WST |
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 Thin Client is WST
.
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 Thin Client 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 Thin Client is an affordable device built to work with Amazon Web Services End User Computing (EUC) virtual desktops to provide users with a complete cloud desktop solution. WorkSpaces Thin Client is a compact device designed to connect up to two monitors and USB devices like a keyboard, mouse, headset, and webcam. To maximize endpoint security, WorkSpaces Thin Client devices do not allow local data storage or installation of unapproved applications. The WorkSpaces Thin Client device ships preloaded with device management software.
You can use these APIs to complete WorkSpaces Thin Client tasks, such as creating environments or viewing devices. For more information about WorkSpaces Thin Client, including the required permissions to use the service, see the Amazon WorkSpaces Thin Client Administrator Guide. For more information about using the Command Line Interface (CLI) to manage your WorkSpaces Thin Client resources, see the WorkSpaces Thin Client section of the CLI Reference.
Using the SDK¶
In your code, create a client using the SDK module for Amazon WorkSpaces Thin Client, which is created with
factory method /AWS1/CL_WST_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_wst) = /aws1/cl_wst_factory=>create( go_session ).
Your variable go_wst
is an instance of /AWS1/IF_WST
,
and all of the operations
in the Amazon WorkSpaces Thin Client service are accessed by calling methods in /AWS1/IF_WST
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon WorkSpaces Thin Client, see the Operation List.
Factory Method¶
/AWS1/CL_WST_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_WST
.
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_WST
/AWS1/IF_WST
¶
/AWS1/IF_WST
represents the ABAP client for the WorkSpaces Thin Client service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_wst)->get_config( ).
lo_config
is a variable of type /AWS1/CL_WST_CONFIG
. See the documentation for /AWS1/CL_WST_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon WorkSpaces Thin Client can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_WST_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 Thin Client can be found in interface /AWS1/IF_WST_PAGINATOR
.