Paginators
Auto-generated documentation for Kinesis type annotations stubs module mypy-boto3-kinesis.
DescribeStreamPaginator
Type annotations and code completion for boto3.client("kinesis").get_paginator("describe_stream")
.
boto3 documentation
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")
from boto3.session import Session
from mypy_boto3_kinesis.paginator import DescribeStreamPaginator
session = Session()
client = Session().client("kinesis") # (1)
paginator: DescribeStreamPaginator = client.get_paginator("describe_stream") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: KinesisClient
- paginator: DescribeStreamPaginator
- item: DescribeStreamOutputTypeDef
paginate
Type annotations and code completion for DescribeStreamPaginator.paginate
method.
def paginate(
self,
*,
StreamName: str = ...,
StreamARN: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> _PageIterator[DescribeStreamOutputTypeDef]: # (2)
...
kwargs: DescribeStreamInputDescribeStreamPaginateTypeDef = { # (1)
"StreamName": ...,
}
parent.paginate(**kwargs)
ListShardsPaginator
Type annotations and code completion for boto3.client("kinesis").get_paginator("list_shards")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_kinesis.paginator import ListShardsPaginator
def get_list_shards_paginator() -> ListShardsPaginator:
return Session().client("kinesis").get_paginator("list_shards")
from boto3.session import Session
from mypy_boto3_kinesis.paginator import ListShardsPaginator
session = Session()
client = Session().client("kinesis") # (1)
paginator: ListShardsPaginator = client.get_paginator("list_shards") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: KinesisClient
- paginator: ListShardsPaginator
- item: ListShardsOutputTypeDef
paginate
Type annotations and code completion for ListShardsPaginator.paginate
method.
def paginate(
self,
*,
StreamName: str = ...,
ExclusiveStartShardId: str = ...,
StreamCreationTimestamp: Union[datetime, str] = ...,
ShardFilter: ShardFilterTypeDef = ..., # (1)
StreamARN: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[ListShardsOutputTypeDef]: # (3)
...
kwargs: ListShardsInputListShardsPaginateTypeDef = { # (1)
"StreamName": ...,
}
parent.paginate(**kwargs)
ListStreamConsumersPaginator
Type annotations and code completion for boto3.client("kinesis").get_paginator("list_stream_consumers")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_kinesis.paginator import ListStreamConsumersPaginator
def get_list_stream_consumers_paginator() -> ListStreamConsumersPaginator:
return Session().client("kinesis").get_paginator("list_stream_consumers")
from boto3.session import Session
from mypy_boto3_kinesis.paginator import ListStreamConsumersPaginator
session = Session()
client = Session().client("kinesis") # (1)
paginator: ListStreamConsumersPaginator = client.get_paginator("list_stream_consumers") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: KinesisClient
- paginator: ListStreamConsumersPaginator
- item: ListStreamConsumersOutputTypeDef
paginate
Type annotations and code completion for ListStreamConsumersPaginator.paginate
method.
def paginate(
self,
*,
StreamARN: str,
StreamCreationTimestamp: Union[datetime, str] = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> _PageIterator[ListStreamConsumersOutputTypeDef]: # (2)
...
kwargs: ListStreamConsumersInputListStreamConsumersPaginateTypeDef = { # (1)
"StreamARN": ...,
}
parent.paginate(**kwargs)
ListStreamsPaginator
Type annotations and code completion for boto3.client("kinesis").get_paginator("list_streams")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_kinesis.paginator import ListStreamsPaginator
def get_list_streams_paginator() -> ListStreamsPaginator:
return Session().client("kinesis").get_paginator("list_streams")
from boto3.session import Session
from mypy_boto3_kinesis.paginator import ListStreamsPaginator
session = Session()
client = Session().client("kinesis") # (1)
paginator: ListStreamsPaginator = client.get_paginator("list_streams") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: KinesisClient
- paginator: ListStreamsPaginator
- item: ListStreamsOutputTypeDef
paginate
Type annotations and code completion for ListStreamsPaginator.paginate
method.
def paginate(
self,
*,
ExclusiveStartStreamName: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> _PageIterator[ListStreamsOutputTypeDef]: # (2)
...