ivsrealtime

Client

class ivsrealtime.Client

A low-level client representing Amazon Interactive Video Service RealTime (ivsrealtime)

The Amazon Interactive Video Service (IVS) real-time 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.

Key Concepts

• Stage — A virtual space where participants can exchange video in real time.

• Participant token — A token that authenticates a participant when they join a stage.

• 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.

For server-side composition:

• Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.

• Composition — Controls the look of the outputs, including how participants are positioned in the video.

For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.

Tagging

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 Best practices and strategies in Tagging AWS Resources and Tag Editor for details, 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 real-time API has these tag-related operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.

At most 50 tags can be applied to a resource.

import boto3

client = boto3.client('ivs-realtime')

These are the available methods:

• can_paginate
• close
• create_encoder_configuration
• create_ingest_configuration
• create_participant_token
• create_stage
• create_storage_configuration
• delete_encoder_configuration
• delete_ingest_configuration
• delete_public_key
• delete_stage
• delete_storage_configuration
• disconnect_participant
• get_composition
• get_encoder_configuration
• get_ingest_configuration
• get_paginator
• get_participant
• get_public_key
• get_stage
• get_stage_session
• get_storage_configuration
• get_waiter
• import_public_key
• list_compositions
• list_encoder_configurations
• list_ingest_configurations
• list_participant_events
• list_participants
• list_public_keys
• list_stage_sessions
• list_stages
• list_storage_configurations
• list_tags_for_resource
• start_composition
• stop_composition
• tag_resource
• untag_resource
• update_ingest_configuration
• update_stage

Client Exceptions

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:

• AccessDeniedException
• ConflictException
• InternalServerException
• PendingVerification
• ResourceNotFoundException
• ServiceQuotaExceededException
• ValidationException

Paginators

Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.

The available paginators are:

• ListIngestConfigurations
• ListPublicKeys