Skip to content

Kinesis module#

Index > Kinesis

Auto-generated documentation for Kinesis type annotations stubs module types-aiobotocore-kinesis.

How to install#

From PyPI with pip#

Install types-aiobotocore for Kinesis service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[kinesis]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[kinesis]'


# standalone installation
python -m pip install types-aiobotocore-kinesis

How to uninstall#

python -m pip uninstall -y types-aiobotocore-kinesis

Usage#

Code samples can be found in Examples.

KinesisClient#

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

# KinesisClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_kinesis.client import KinesisClient


session = get_session()
async with session.create_client("kinesis") as client:
    client: KinesisClient

Paginators#

Type annotations and code completion for paginators from session.create_client("kinesis").get_paginator("...").

# DescribeStreamPaginator usage example

from types_aiobotocore_kinesis.paginator import DescribeStreamPaginator

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

Waiters#

Type annotations and code completion for waiters from session.create_client("kinesis").get_waiter("...").

# StreamExistsWaiter usage example

from types_aiobotocore_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 types_aiobotocore_kinesis.literals import ConsumerStatusType

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

Type definitions#

Type annotations for type definitions used in methods and schema.