Paginators

Index > Kinesis > Paginators

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

DescribeStreamPaginator

Type annotations and code completion for session.client("kinesis").get_paginator("describe_stream"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_kinesis.paginator import DescribeStreamPaginator

session = Session()

session = get_session()
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)

1. client: KinesisClient
2. paginator: DescribeStreamPaginator
3. item: DescribeStreamOutputTypeDef

paginate

Type annotations and code completion for DescribeStreamPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    StreamName: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DescribeStreamOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See DescribeStreamOutputTypeDef

Usage example with kwargs

kwargs: DescribeStreamInputDescribeStreamPaginateTypeDef = {  # (1)
    "StreamName": ...,
}

parent.paginate(**kwargs)

1. See DescribeStreamInputDescribeStreamPaginateTypeDef

ListShardsPaginator

Type annotations and code completion for session.client("kinesis").get_paginator("list_shards"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_kinesis.paginator import ListShardsPaginator

session = Session()

session = get_session()
async with session.client("kinesis") as client:  # (1)
    paginator: ListShardsPaginator = client.get_paginator("list_shards")  # (2)
    async for item in paginator.paginate(...):
        item: ListShardsOutputTypeDef
        print(item)  # (3)

1. client: KinesisClient
2. paginator: ListShardsPaginator
3. item: ListShardsOutputTypeDef

paginate

Type annotations and code completion for ListShardsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    StreamName: str = ...,
    ExclusiveStartShardId: str = ...,
    StreamCreationTimestamp: Union[datetime, str] = ...,
    ShardFilter: ShardFilterTypeDef = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> AsyncIterator[ListShardsOutputTypeDef]:  # (3)
    ...

1. See ShardFilterTypeDef
2. See PaginatorConfigTypeDef
3. See ListShardsOutputTypeDef

Usage example with kwargs

kwargs: ListShardsInputListShardsPaginateTypeDef = {  # (1)
    "StreamName": ...,
}

parent.paginate(**kwargs)

1. See ListShardsInputListShardsPaginateTypeDef

ListStreamConsumersPaginator

Type annotations and code completion for session.client("kinesis").get_paginator("list_stream_consumers"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_kinesis.paginator import ListStreamConsumersPaginator

session = Session()

session = get_session()
async with session.client("kinesis") as client:  # (1)
    paginator: ListStreamConsumersPaginator = client.get_paginator("list_stream_consumers")  # (2)
    async for item in paginator.paginate(...):
        item: ListStreamConsumersOutputTypeDef
        print(item)  # (3)

1. client: KinesisClient
2. paginator: ListStreamConsumersPaginator
3. item: ListStreamConsumersOutputTypeDef

paginate

Type annotations and code completion for ListStreamConsumersPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    StreamARN: str,
    StreamCreationTimestamp: Union[datetime, str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListStreamConsumersOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListStreamConsumersOutputTypeDef

Usage example with kwargs

kwargs: ListStreamConsumersInputListStreamConsumersPaginateTypeDef = {  # (1)
    "StreamARN": ...,
}

parent.paginate(**kwargs)

1. See ListStreamConsumersInputListStreamConsumersPaginateTypeDef

ListStreamsPaginator

Type annotations and code completion for session.client("kinesis").get_paginator("list_streams"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_kinesis.paginator import ListStreamsPaginator

session = Session()

session = get_session()
async with session.client("kinesis") as client:  # (1)
    paginator: ListStreamsPaginator = client.get_paginator("list_streams")  # (2)
    async for item in paginator.paginate(...):
        item: ListStreamsOutputTypeDef
        print(item)  # (3)

1. client: KinesisClient
2. paginator: ListStreamsPaginator
3. item: ListStreamsOutputTypeDef

paginate

Type annotations and code completion for ListStreamsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListStreamsOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListStreamsOutputTypeDef

Usage example with kwargs

kwargs: ListStreamsInputListStreamsPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)

1. See ListStreamsInputListStreamsPaginateTypeDef