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")

Paginators#

Type annotations and code completion for paginators from boto3.client("ivs-realtime").get_paginator("...").

# ListPublicKeysPaginator usage example

from boto3.session import Session

from mypy_boto3_ivs_realtime.paginator import ListPublicKeysPaginator

def get_list_public_keys_paginator() -> ListPublicKeysPaginator:
    return Session().client("ivs-realtime").get_paginator("list_public_keys"))

Literals#

Type annotations for literals used in methods and schema.

# CompositionStateType usage example

from mypy_boto3_ivs_realtime.literals import CompositionStateType

def get_value() -> CompositionStateType:
    return "ACTIVE"

Type definitions#

Type annotations for type definitions used in methods and schema.