Skip to content

KinesisVideo module#

Index > KinesisVideo

Auto-generated documentation for KinesisVideo type annotations stubs module mypy-boto3-kinesisvideo.

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

From PyPI with pip#

Install boto3-stubs for KinesisVideo service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

KinesisVideoClient#

Type annotations and code completion for boto3.client("kinesisvideo") as KinesisVideoClient boto3 documentation

# KinesisVideoClient usage example

from boto3.session import Session

from mypy_boto3_kinesisvideo.client import KinesisVideoClient

def get_client() -> KinesisVideoClient:
    return Session().client("kinesisvideo")

Paginators#

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

# DescribeMappedResourceConfigurationPaginator usage example

from boto3.session import Session

from mypy_boto3_kinesisvideo.paginator import DescribeMappedResourceConfigurationPaginator

def get_describe_mapped_resource_configuration_paginator() -> DescribeMappedResourceConfigurationPaginator:
    return Session().client("kinesisvideo").get_paginator("describe_mapped_resource_configuration"))

Literals#

Type annotations for literals used in methods and schemas.

# APINameType usage example

from mypy_boto3_kinesisvideo.literals import APINameType

def get_value() -> APINameType:
    return "GET_CLIP"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# SingleMasterConfigurationTypeDef usage example

from mypy_boto3_kinesisvideo.type_defs import SingleMasterConfigurationTypeDef

def get_value() -> SingleMasterConfigurationTypeDef:
    return {
        "MessageTtlSeconds": ...,
    }