KeyspacesStreams module#
Index > KeyspacesStreams
Auto-generated documentation for KeyspacesStreams type annotations stubs module mypy-boto3-keyspacesstreams.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.38.45' mypy-boto3-builder
- Select
boto3-stubs
AWS SDK. - Add
KeyspacesStreams
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and KeyspacesStreams
.
From PyPI with pip#
Install boto3-stubs
for KeyspacesStreams
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[keyspacesstreams]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[keyspacesstreams]'
# standalone installation
python -m pip install mypy-boto3-keyspacesstreams
How to uninstall#
python -m pip uninstall -y mypy-boto3-keyspacesstreams
Usage#
Code samples can be found in Examples.
KeyspacesStreamsClient#
Type annotations and code completion for boto3.client("keyspacesstreams")
as KeyspacesStreamsClient
boto3 documentation
# KeyspacesStreamsClient usage example
from boto3.session import Session
from mypy_boto3_keyspacesstreams.client import KeyspacesStreamsClient
def get_client() -> KeyspacesStreamsClient:
return Session().client("keyspacesstreams")
Paginators#
Type annotations and code completion for paginators
from boto3.client("keyspacesstreams").get_paginator("...")
.
# GetStreamPaginator usage example
from boto3.session import Session
from mypy_boto3_keyspacesstreams.paginator import GetStreamPaginator
def get_get_stream_paginator() -> GetStreamPaginator:
return Session().client("keyspacesstreams").get_paginator("get_stream"))
Literals#
Type annotations for literals used in methods and schema.
# GetStreamPaginatorName usage example
from mypy_boto3_keyspacesstreams.literals import GetStreamPaginatorName
def get_value() -> GetStreamPaginatorName:
return "get_stream"
- GetStreamPaginatorName
- ListStreamsPaginatorName
- OriginTypeType
- ShardFilterTypeType
- ShardIteratorTypeType
- StreamStatusType
- StreamViewTypeType
- KeyspacesStreamsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- GetRecordsInputTypeDef
- ResponseMetadataTypeDef
- GetShardIteratorInputTypeDef
- PaginatorConfigTypeDef
- ShardFilterTypeDef
- KeyspacesMetadataTypeDef
- ListStreamsInputTypeDef
- StreamTypeDef
- SequenceNumberRangeTypeDef
- GetShardIteratorOutputTypeDef
- ListStreamsInputPaginateTypeDef
- GetStreamInputPaginateTypeDef
- GetStreamInputTypeDef
- KeyspacesCellMapDefinitionTypeDef
- KeyspacesCellTypeDef
- ListStreamsOutputTypeDef
- ShardTypeDef
- KeyspacesCellValueTypeDef
- KeyspacesRowTypeDef
- GetStreamOutputTypeDef
- RecordTypeDef
- GetRecordsOutputTypeDef