Skip to content

IVS module#

Index > IVS

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

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

From PyPI with pip#

Install boto3-stubs for IVS service.

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

# 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]'

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

How to uninstall#

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


Code samples can be found in Examples.


Type annotations and code completion for boto3.client("ivs") as IVSClient boto3 documentation

# IVSClient usage example

from boto3.session import Session

from mypy_boto3_ivs.client import IVSClient

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


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

# ListChannelsPaginator usage example

from boto3.session import Session

from mypy_boto3_ivs.paginator import ListChannelsPaginator

def get_list_channels_paginator() -> ListChannelsPaginator:
    return Session().client("ivs").get_paginator("list_channels"))


Type annotations for literals used in methods and schemas.

# ChannelLatencyModeType usage example

from mypy_boto3_ivs.literals import ChannelLatencyModeType

def get_value() -> ChannelLatencyModeType:
    return "LOW"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AudioConfigurationTypeDef usage example

from mypy_boto3_ivs.type_defs import AudioConfigurationTypeDef

def get_value() -> AudioConfigurationTypeDef:
    return {
        "channels": ...,