API for Amazon GameLift Streams¶
| ABAP Package | /AWS1/API_GMZ_IMPL |
|---|---|
| ABAP SDK "TLA" | GMZ |
| ABAP Interface | /AWS1/IF_GMZ |
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 GameLift Streams is GMZ.
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 GameLiftStreams 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 GameLift Streams provides a global cloud solution for content streaming experiences. Use Amazon GameLift Streams tools to upload and configure content for streaming, deploy and scale computing resources to host streams, and manage stream session placement to meet customer demand.
This Reference Guide describes the Amazon GameLift Streams service API. You can use the API through the Amazon Web Services SDK, the Command Line Interface (AWS CLI), or by making direct REST calls through HTTPS.
See the Amazon GameLift Streams Developer Guide for more information on how Amazon GameLift Streams works and how to work with it.
Using the SDK¶
In your code, create a client using the SDK module for Amazon GameLift Streams, which is created with
factory method /AWS1/CL_GMZ_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_gmz) = /aws1/cl_gmz_factory=>create( go_session ).
Your variable go_gmz is an instance of /AWS1/IF_GMZ,
and all of the operations
in the Amazon GameLift Streams service are accessed by calling methods in /AWS1/IF_GMZ.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon GameLift Streams, see the Operation List.
Factory Method¶
/AWS1/CL_GMZ_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_GMZ.
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_gmz /AWS1/IF_GMZ¶
/AWS1/IF_GMZrepresents the ABAP client for the GameLiftStreams service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_gmz)->get_config( ).
lo_config is a variable of type /AWS1/CL_GMZ_CONFIG. See the documentation for /AWS1/CL_GMZ_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_GMZ_WAITER`](./_AWS1_IF_GMZ_WAITER.md).
Paginators¶
Paginators for Amazon GameLift Streams can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_GMZ_PAGINATOR`](./_AWS1_IF_GMZ_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 GameLift Streams can be found in interface [`/AWS1/IF_GMZ_PAGINATOR`](./_AWS1_IF_GMZ_PAGINATOR.md).