API for Amazon AppStream¶
| ABAP Package | /AWS1/API_APS_IMPL |
|---|---|
| ABAP SDK "TLA" | APS |
| ABAP Interface | /AWS1/IF_APS |
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 AppStream is APS.
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 AppStream 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¶
This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.
You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.
To learn more about AppStream 2.0, see the following resources:
Using the SDK¶
In your code, create a client using the SDK module for Amazon AppStream, which is created with
factory method /AWS1/CL_APS_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_aps) = /aws1/cl_aps_factory=>create( go_session ).
Your variable go_aps is an instance of /AWS1/IF_APS,
and all of the operations
in the Amazon AppStream service are accessed by calling methods in /AWS1/IF_APS.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon AppStream, see the Operation List.
Factory Method¶
/AWS1/CL_APS_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_APS.
IMPORTING¶
Optional arguments:¶
iv_protocol TYPE /aws1/rt_protocol /AWS1/RT_PROTOCOL¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
io_session TYPE REF TO /aws1/cl_rt_session_base /AWS1/CL_RT_SESSION_BASE¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
iv_region TYPE /aws1/rt_region_id /AWS1/RT_REGION_ID¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
iv_custom_endpoint TYPE /aws1/rt_endpoint /AWS1/RT_ENDPOINT¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
RETURNING¶
oo_client TYPE REF TO /aws1/if_aps /AWS1/IF_APS¶
/AWS1/IF_APSrepresents the ABAP client for the AppStream service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_aps)->get_config( ).
lo_config is a variable of type /AWS1/CL_APS_CONFIG. See the documentation for /AWS1/CL_APS_CONFIG for
details on the settings that can be configured.
Waiters¶
Waiters for Implementation can be accessed via `get_waiter()` method followed by the waiter method to be called.
Details about the waiter methods available for service Implementation can be found in interface [`/AWS1/IF_APS_WAITER`](./_AWS1_IF_APS_WAITER.md).
Paginators¶
Paginators for Amazon AppStream can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_APS_PAGINATOR`](./_AWS1_IF_APS_PAGINATOR.md). 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 AppStream can be found in interface [`/AWS1/IF_APS_PAGINATOR`](./_AWS1_IF_APS_PAGINATOR.md).