Kinesis module
Index > Kinesis
Auto-generated documentation for Kinesis type annotations stubs module mypy-boto3-kinesis.
How to install
VSCode extension
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Kinesis
.
From PyPI with pip
Install boto3-stubs
for Kinesis
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[kinesis]'
# 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[kinesis]'
# standalone installation
python -m pip install mypy-boto3-kinesis
How to uninstall
Usage
Code samples can be found in Examples.
KinesisClient
Type annotations and code completion for boto3.client("kinesis")
as KinesisClient
boto3 documentation
Usage example
from boto3.session import Session
from mypy_boto3_kinesis.client import KinesisClient
def get_client() -> KinesisClient:
return Session().client("kinesis")
Paginators
Type annotations and code completion for paginators
from boto3.client("kinesis").get_paginator("...")
.
Usage example
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"))
Waiters
Type annotations and code completion for waiters
from boto3.client("kinesis").get_waiter("...")
.
Usage example
from boto3.session import Session
from mypy_boto3_kinesis.waiter import StreamExistsWaiter
def get_stream_exists_waiter() -> StreamExistsWaiter:
return Session().client("kinesis").get_waiter("stream_exists")
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_kinesis.literals import ConsumerStatusType
def get_value() -> ConsumerStatusType:
return "ACTIVE"
- ConsumerStatusType
- DescribeStreamPaginatorName
- EncryptionTypeType
- ListShardsPaginatorName
- ListStreamConsumersPaginatorName
- ListStreamsPaginatorName
- MetricsNameType
- ScalingTypeType
- ShardFilterTypeType
- ShardIteratorTypeType
- StreamExistsWaiterName
- StreamModeType
- StreamNotExistsWaiterName
- StreamStatusType
- KinesisServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_kinesis.type_defs import AddTagsToStreamInputRequestTypeDef
def get_value() -> AddTagsToStreamInputRequestTypeDef:
return {
"Tags": ...,
}
- AddTagsToStreamInputRequestTypeDef
- HashKeyRangeTypeDef
- ConsumerDescriptionTypeDef
- ConsumerTypeDef
- StreamModeDetailsTypeDef
- DecreaseStreamRetentionPeriodInputRequestTypeDef
- DeleteStreamInputRequestTypeDef
- DeregisterStreamConsumerInputRequestTypeDef
- ResponseMetadataTypeDef
- DescribeStreamConsumerInputRequestTypeDef
- PaginatorConfigTypeDef
- DescribeStreamInputRequestTypeDef
- WaiterConfigTypeDef
- DescribeStreamSummaryInputRequestTypeDef
- DisableEnhancedMonitoringInputRequestTypeDef
- EnableEnhancedMonitoringInputRequestTypeDef
- EnhancedMetricsTypeDef
- GetRecordsInputRequestTypeDef
- RecordTypeDef
- GetShardIteratorInputRequestTypeDef
- IncreaseStreamRetentionPeriodInputRequestTypeDef
- InternalFailureExceptionTypeDef
- KMSAccessDeniedExceptionTypeDef
- KMSDisabledExceptionTypeDef
- KMSInvalidStateExceptionTypeDef
- KMSNotFoundExceptionTypeDef
- KMSOptInRequiredTypeDef
- KMSThrottlingExceptionTypeDef
- ShardFilterTypeDef
- ListStreamConsumersInputRequestTypeDef
- ListStreamsInputRequestTypeDef
- ListTagsForStreamInputRequestTypeDef
- TagTypeDef
- MergeShardsInputRequestTypeDef
- PutRecordInputRequestTypeDef
- PutRecordsRequestEntryTypeDef
- PutRecordsResultEntryTypeDef
- RegisterStreamConsumerInputRequestTypeDef
- RemoveTagsFromStreamInputRequestTypeDef
- ResourceInUseExceptionTypeDef
- ResourceNotFoundExceptionTypeDef
- SequenceNumberRangeTypeDef
- SplitShardInputRequestTypeDef
- StartStreamEncryptionInputRequestTypeDef
- StartingPositionTypeDef
- StopStreamEncryptionInputRequestTypeDef
- UpdateShardCountInputRequestTypeDef
- ChildShardTypeDef
- CreateStreamInputRequestTypeDef
- StreamSummaryTypeDef
- UpdateStreamModeInputRequestTypeDef
- DescribeLimitsOutputTypeDef
- DescribeStreamConsumerOutputTypeDef
- EmptyResponseMetadataTypeDef
- EnhancedMonitoringOutputTypeDef
- GetShardIteratorOutputTypeDef
- ListStreamConsumersOutputTypeDef
- PutRecordOutputTypeDef
- RegisterStreamConsumerOutputTypeDef
- UpdateShardCountOutputTypeDef
- DescribeStreamInputDescribeStreamPaginateTypeDef
- ListStreamConsumersInputListStreamConsumersPaginateTypeDef
- ListStreamsInputListStreamsPaginateTypeDef
- DescribeStreamInputStreamExistsWaitTypeDef
- DescribeStreamInputStreamNotExistsWaitTypeDef
- StreamDescriptionSummaryTypeDef
- ListShardsInputListShardsPaginateTypeDef
- ListShardsInputRequestTypeDef
- ListTagsForStreamOutputTypeDef
- PutRecordsInputRequestTypeDef
- PutRecordsOutputTypeDef
- ShardTypeDef
- SubscribeToShardInputRequestTypeDef
- GetRecordsOutputTypeDef
- SubscribeToShardEventTypeDef
- ListStreamsOutputTypeDef
- DescribeStreamSummaryOutputTypeDef
- ListShardsOutputTypeDef
- StreamDescriptionTypeDef
- SubscribeToShardEventStreamTypeDef
- DescribeStreamOutputTypeDef
- SubscribeToShardOutputTypeDef