Examples
Auto-generated documentation for Kinesis type annotations stubs module types-aiobotocore-kinesis.
Client
Implicit type annotations
Can be used with types-aioboto3[kinesis]
package installed.
Write your Kinesis
code as usual,
type checking and code completion should work out of the box.
Client usage example
from aioboto3.session import Session
session = Session()
async with session.client("kinesis") as client: # (1)
result = await client.add_tags_to_stream() # (2)
- client: KinesisClient
- result: EmptyResponseMetadataTypeDef
Paginator usage example
from aioboto3.session import Session
session = Session()
async with session.client("kinesis") as client: # (1)
paginator = client.get_paginator("describe_stream") # (2)
async for item in paginator.paginate(...):
print(item) # (3)
- client: KinesisClient
- paginator: DescribeStreamPaginator
- item: DescribeStreamOutputTypeDef
Waiter usage example
from aioboto3.session import Session
session = Session()
async with session.client("kinesis") as client: # (1)
waiter = client.get_waiter("stream_exists") # (2)
await waiter.wait()
- client: KinesisClient
- waiter: StreamExistsWaiter
Explicit type annotations
With types-aioboto3-lite[kinesis]
or a standalone types_aiobotocore_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 usage example
from aioboto3.session import Session
from types_aiobotocore_kinesis.client import KinesisClient
from types_aiobotocore_kinesis.type_defs import EmptyResponseMetadataTypeDef
from types_aiobotocore_kinesis.type_defs import AddTagsToStreamInputRequestTypeDef
session = Session()
client: KinesisClient
async with session.client("kinesis") as client: # (1)
kwargs: AddTagsToStreamInputRequestTypeDef = {...} # (2)
result: EmptyResponseMetadataTypeDef = await client.add_tags_to_stream(**kwargs) # (3)
- client: KinesisClient
- kwargs: AddTagsToStreamInputRequestTypeDef
- result: EmptyResponseMetadataTypeDef
Paginator usage example
from aioboto3.session import Session
from types_aiobotocore_kinesis.client import KinesisClient
from types_aiobotocore_kinesis.paginator import DescribeStreamPaginator
from types_aiobotocore_kinesis.type_defs import DescribeStreamOutputTypeDef
session = Session()
client: KinesisClient
async with session.client("kinesis") as client: # (1)
paginator: DescribeStreamPaginator = client.get_paginator("describe_stream") # (2)
async for item in paginator.paginate(...):
item: DescribeStreamOutputTypeDef
print(item) # (3)
- client: KinesisClient
- paginator: DescribeStreamPaginator
- item: DescribeStreamOutputTypeDef
Waiter usage example
from aioboto3.session import Session
from types_aiobotocore_kinesis.client import KinesisClient
from types_aiobotocore_kinesis.waiter import StreamExistsWaiter
session = Session()
async with session.client("kinesis") as client: # (1)
waiter = client.get_waiter("stream_exists") # (2)
await waiter.wait()
- client: KinesisClient
- waiter: StreamExistsWaiter