API for Amazon Interactive Video Service RealTime¶
|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 Interactive Video Service RealTime 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 IVS RealTime 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¶
The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
The IVS stage API sometimes is referred to as the IVS RealTime API.
A participant token is an authorization token used to publish/subscribe to a stage.
A participant object represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID There is a 1:1 mapping between participant tokens and participants.
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):
Stage — A stage is a virtual space where multiple participants can exchange audio and video in real time.
A tag is a metadata label that you assign to an AWS resource. A tag
comprises a key and a value, both set by you. For
example, you might set a tag as
topic:nature to label a particular video
category. See Tagging AWS Resources for more information, including restrictions that apply to
tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific
constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS stage API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
CreateStage — Creates a new stage (and optionally participant tokens).
DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
GetParticipant — Gets information about the specified participant token.
GetStage — Gets information for the specified stage.
GetStageSession — Gets information for the specified stage session.
ListParticipantEvents — Lists events for a specified participant that occurred during a specified stage session.
ListParticipants — Lists all participants in a specified stage session.
ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
ListStageSessions — Gets all sessions for a specified stage.
UpdateStage — Updates a stage’s configuration.
ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
Using the SDK¶
In your code, create a client using the SDK module for Amazon Interactive Video Service RealTime, 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_ivr) = /aws1/cl_ivr_factory=>create( go_session ).
go_ivr is an instance of
and all of the operations
in the Amazon Interactive Video Service RealTime service are accessed by calling methods in
For an overview of ABAP method calls corresponding to API operations in Amazon Interactive Video Service RealTime, see the Operation List.
Creates an object of type
TYPE REF TO
TYPE REF TO
/AWS1/IF_IVRrepresents the ABAP client for the IVS RealTime service, representing each operation as a method call. For more information see the API Page page.
data(lo_config) = DATA(go_ivr)->get_config( ).
lo_config is a variable of type
/AWS1/CL_IVR_CONFIG. See the documentation for
details on the settings that can be configured.
Paginators for Amazon Interactive Video Service RealTime can be created via
get_paginator() which returns a paginator object of type
/AWS1/IF_IVR_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 Interactive Video Service RealTime can be found in interface