Examples#
Auto-generated documentation for Kinesis type annotations stubs module mypy-boto3-kinesis.
Client#
Implicit type annotations#
Can be used with boto3-stubs[kinesis]
package installed.
Write your Kinesis
code as usual,
type checking and code completion should work out of the box.
Client method usage example#
# KinesisClient usage example
from boto3.session import Session
session = Session()
client = session.client("kinesis") # (1)
result = client.add_tags_to_stream() # (2)
- client: KinesisClient
- result: EmptyResponseMetadataTypeDef
Paginator usage example#
# DescribeStreamPaginator usage example
from boto3.session import Session
session = Session()
client = session.client("kinesis") # (1)
paginator = client.get_paginator("describe_stream") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: KinesisClient
- paginator: DescribeStreamPaginator
- item: DescribeStreamOutputTypeDef
Waiter usage example#
# StreamExistsWaiter usage example
from boto3.session import Session
session = Session()
client = session.client("kinesis") # (1)
waiter = client.get_waiter("stream_exists") # (2)
waiter.wait(...)
- client: KinesisClient
- waiter: StreamExistsWaiter
Explicit type annotations#
With boto3-stubs-lite[kinesis]
or a standalone mypy_boto3_kinesis
package, you have to explicitly specify client: KinesisClient
type annotation.
All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.
Client method usage example#
# KinesisClient usage example with type annotations
from boto3.session import Session
from mypy_boto3_kinesis.client import KinesisClient
from mypy_boto3_kinesis.type_defs import EmptyResponseMetadataTypeDef
from mypy_boto3_kinesis.type_defs import AddTagsToStreamInputTypeDef
session = Session()
client: KinesisClient = session.client("kinesis")
kwargs: AddTagsToStreamInputTypeDef = {...}
result: EmptyResponseMetadataTypeDef = client.add_tags_to_stream(**kwargs)
Paginator usage example#
# DescribeStreamPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_kinesis.client import KinesisClient
from mypy_boto3_kinesis.paginator import DescribeStreamPaginator
from mypy_boto3_kinesis.type_defs import DescribeStreamOutputTypeDef
session = Session()
client: KinesisClient = session.client("kinesis")
paginator: DescribeStreamPaginator = client.get_paginator("describe_stream")
for item in paginator.paginate(...):
item: DescribeStreamOutputTypeDef
print(item)
Waiter usage example#
# StreamExistsWaiter usage example with type annotations
from boto3.session import Session
from mypy_boto3_kinesis.client import KinesisClient
from mypy_boto3_kinesis.waiter import StreamExistsWaiter
session = Session()
client: KinesisClient = session.client("kinesis")
waiter: StreamExistsWaiter = client.get_waiter("stream_exists")
waiter.wait(...)