Skip to content

IVS module#

Index > IVS

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

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.36.2' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add IVS service.
  4. Use provided commands to install generated packages.

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

Usage#

Code samples can be found in Examples.

IVSClient#

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

Paginators#

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

Literals#

Type annotations for literals used in methods and schema.

# ChannelLatencyModeType usage example

from mypy_boto3_ivs.literals import ChannelLatencyModeType

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