- class ivsrealtime.Client#
A low-level client representing Amazon Interactive Video Service RealTime (ivsrealtime)
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:natureto 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.
client = session.create_client('ivs-realtime')
These are the available methods:
Client exceptions are available on a client instance via the
exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are: