Skip to content

ivsrealtime module#

Index > ivsrealtime

Auto-generated documentation for ivsrealtime type annotations stubs module mypy-boto3-ivs-realtime.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and ivsrealtime.

From PyPI with pip#

Install boto3-stubs for ivsrealtime service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[ivs-realtime]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[ivs-realtime]'


# standalone installation
python -m pip install mypy-boto3-ivs-realtime

How to uninstall#

python -m pip uninstall -y mypy-boto3-ivs-realtime

Usage#

Code samples can be found in Examples.

ivsrealtimeClient#

Type annotations and code completion for boto3.client("ivs-realtime") as ivsrealtimeClient boto3 documentation

# ivsrealtimeClient usage example

from boto3.session import Session

from mypy_boto3_ivs_realtime.client import ivsrealtimeClient

def get_client() -> ivsrealtimeClient:
    return Session().client("ivs-realtime")

Literals#

Type annotations for literals used in methods and schema.

# EventErrorCodeType usage example

from mypy_boto3_ivs_realtime.literals import EventErrorCodeType

def get_value() -> EventErrorCodeType:
    return "INSUFFICIENT_CAPABILITIES"

Type definitions#

Type annotations for type definitions used in methods and schema.