Skip to content

Kinesis module#

Index > Kinesis

Auto-generated documentation for Kinesis type annotations stubs module mypy-boto3-kinesis.

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.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add Kinesis 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 Kinesis.

From PyPI with pip#

Install boto3-stubs for Kinesis service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

KinesisClient#

Type annotations and code completion for boto3.client("kinesis") as KinesisClient boto3 documentation

# KinesisClient usage example

from boto3.session import Session

from mypy_boto3_kinesis.client import KinesisClient

def get_client() -> KinesisClient:
    return Session().client("kinesis")

Paginators#

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

# DescribeStreamPaginator usage example

from boto3.session import Session

from mypy_boto3_kinesis.paginator import DescribeStreamPaginator

def get_describe_stream_paginator() -> DescribeStreamPaginator:
    return Session().client("kinesis").get_paginator("describe_stream"))

Waiters#

Type annotations and code completion for waiters from boto3.client("kinesis").get_waiter("...").

# StreamExistsWaiter usage example

from boto3.session import Session

from mypy_boto3_kinesis.waiter import StreamExistsWaiter

def get_stream_exists_waiter() -> StreamExistsWaiter:
    return Session().client("kinesis").get_waiter("stream_exists")

Literals#

Type annotations for literals used in methods and schema.

# ConsumerStatusType usage example

from mypy_boto3_kinesis.literals import ConsumerStatusType

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

Type definitions#

Type annotations for type definitions used in methods and schema.