Typed dictionaries
Auto-generated documentation for Kinesis type annotations stubs module mypy-boto3-kinesis.
AddTagsToStreamInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import AddTagsToStreamInputRequestTypeDef
def get_value() -> AddTagsToStreamInputRequestTypeDef:
return {
"Tags": ...,
}
Definition
class AddTagsToStreamInputRequestTypeDef(TypedDict):
Tags: Mapping[str, str],
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
HashKeyRangeTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import HashKeyRangeTypeDef
def get_value() -> HashKeyRangeTypeDef:
return {
"StartingHashKey": ...,
"EndingHashKey": ...,
}
ConsumerDescriptionTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ConsumerDescriptionTypeDef
def get_value() -> ConsumerDescriptionTypeDef:
return {
"ConsumerName": ...,
"ConsumerARN": ...,
"ConsumerStatus": ...,
"ConsumerCreationTimestamp": ...,
"StreamARN": ...,
}
Definition
class ConsumerDescriptionTypeDef(TypedDict):
ConsumerName: str,
ConsumerARN: str,
ConsumerStatus: ConsumerStatusType, # (1)
ConsumerCreationTimestamp: datetime,
StreamARN: str,
ConsumerTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ConsumerTypeDef
def get_value() -> ConsumerTypeDef:
return {
"ConsumerName": ...,
"ConsumerARN": ...,
"ConsumerStatus": ...,
"ConsumerCreationTimestamp": ...,
}
Definition
class ConsumerTypeDef(TypedDict):
ConsumerName: str,
ConsumerARN: str,
ConsumerStatus: ConsumerStatusType, # (1)
ConsumerCreationTimestamp: datetime,
StreamModeDetailsTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import StreamModeDetailsTypeDef
def get_value() -> StreamModeDetailsTypeDef:
return {
"StreamMode": ...,
}
- See StreamModeType
DecreaseStreamRetentionPeriodInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DecreaseStreamRetentionPeriodInputRequestTypeDef
def get_value() -> DecreaseStreamRetentionPeriodInputRequestTypeDef:
return {
"RetentionPeriodHours": ...,
}
Definition
class DecreaseStreamRetentionPeriodInputRequestTypeDef(TypedDict):
RetentionPeriodHours: int,
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
DeleteStreamInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DeleteStreamInputRequestTypeDef
def get_value() -> DeleteStreamInputRequestTypeDef:
return {
"StreamName": ...,
}
Definition
class DeleteStreamInputRequestTypeDef(TypedDict):
StreamName: NotRequired[str],
EnforceConsumerDeletion: NotRequired[bool],
StreamARN: NotRequired[str],
DeregisterStreamConsumerInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DeregisterStreamConsumerInputRequestTypeDef
def get_value() -> DeregisterStreamConsumerInputRequestTypeDef:
return {
"StreamARN": ...,
}
Definition
class DeregisterStreamConsumerInputRequestTypeDef(TypedDict):
StreamARN: NotRequired[str],
ConsumerName: NotRequired[str],
ConsumerARN: NotRequired[str],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
DescribeStreamConsumerInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DescribeStreamConsumerInputRequestTypeDef
def get_value() -> DescribeStreamConsumerInputRequestTypeDef:
return {
"StreamARN": ...,
}
Definition
class DescribeStreamConsumerInputRequestTypeDef(TypedDict):
StreamARN: NotRequired[str],
ConsumerName: NotRequired[str],
ConsumerARN: NotRequired[str],
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeStreamInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DescribeStreamInputRequestTypeDef
def get_value() -> DescribeStreamInputRequestTypeDef:
return {
"StreamName": ...,
}
Definition
class DescribeStreamInputRequestTypeDef(TypedDict):
StreamName: NotRequired[str],
Limit: NotRequired[int],
ExclusiveStartShardId: NotRequired[str],
StreamARN: NotRequired[str],
WaiterConfigTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import WaiterConfigTypeDef
def get_value() -> WaiterConfigTypeDef:
return {
"Delay": ...,
}
Definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
DescribeStreamSummaryInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DescribeStreamSummaryInputRequestTypeDef
def get_value() -> DescribeStreamSummaryInputRequestTypeDef:
return {
"StreamName": ...,
}
Definition
class DescribeStreamSummaryInputRequestTypeDef(TypedDict):
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
DisableEnhancedMonitoringInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DisableEnhancedMonitoringInputRequestTypeDef
def get_value() -> DisableEnhancedMonitoringInputRequestTypeDef:
return {
"ShardLevelMetrics": ...,
}
Definition
class DisableEnhancedMonitoringInputRequestTypeDef(TypedDict):
ShardLevelMetrics: Sequence[MetricsNameType], # (1)
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
- See MetricsNameType
EnableEnhancedMonitoringInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import EnableEnhancedMonitoringInputRequestTypeDef
def get_value() -> EnableEnhancedMonitoringInputRequestTypeDef:
return {
"ShardLevelMetrics": ...,
}
Definition
class EnableEnhancedMonitoringInputRequestTypeDef(TypedDict):
ShardLevelMetrics: Sequence[MetricsNameType], # (1)
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
- See MetricsNameType
EnhancedMetricsTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import EnhancedMetricsTypeDef
def get_value() -> EnhancedMetricsTypeDef:
return {
"ShardLevelMetrics": ...,
}
Definition
class EnhancedMetricsTypeDef(TypedDict):
ShardLevelMetrics: NotRequired[List[MetricsNameType]], # (1)
- See MetricsNameType
GetRecordsInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import GetRecordsInputRequestTypeDef
def get_value() -> GetRecordsInputRequestTypeDef:
return {
"ShardIterator": ...,
}
Definition
class GetRecordsInputRequestTypeDef(TypedDict):
ShardIterator: str,
Limit: NotRequired[int],
StreamARN: NotRequired[str],
RecordTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import RecordTypeDef
def get_value() -> RecordTypeDef:
return {
"SequenceNumber": ...,
"Data": ...,
"PartitionKey": ...,
}
Definition
class RecordTypeDef(TypedDict):
SequenceNumber: str,
Data: bytes,
PartitionKey: str,
ApproximateArrivalTimestamp: NotRequired[datetime],
EncryptionType: NotRequired[EncryptionTypeType], # (1)
GetShardIteratorInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import GetShardIteratorInputRequestTypeDef
def get_value() -> GetShardIteratorInputRequestTypeDef:
return {
"ShardId": ...,
"ShardIteratorType": ...,
}
Definition
class GetShardIteratorInputRequestTypeDef(TypedDict):
ShardId: str,
ShardIteratorType: ShardIteratorTypeType, # (1)
StreamName: NotRequired[str],
StartingSequenceNumber: NotRequired[str],
Timestamp: NotRequired[Union[datetime, str]],
StreamARN: NotRequired[str],
IncreaseStreamRetentionPeriodInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import IncreaseStreamRetentionPeriodInputRequestTypeDef
def get_value() -> IncreaseStreamRetentionPeriodInputRequestTypeDef:
return {
"RetentionPeriodHours": ...,
}
Definition
class IncreaseStreamRetentionPeriodInputRequestTypeDef(TypedDict):
RetentionPeriodHours: int,
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
InternalFailureExceptionTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import InternalFailureExceptionTypeDef
def get_value() -> InternalFailureExceptionTypeDef:
return {
"message": ...,
}
KMSAccessDeniedExceptionTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import KMSAccessDeniedExceptionTypeDef
def get_value() -> KMSAccessDeniedExceptionTypeDef:
return {
"message": ...,
}
KMSDisabledExceptionTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import KMSDisabledExceptionTypeDef
def get_value() -> KMSDisabledExceptionTypeDef:
return {
"message": ...,
}
KMSInvalidStateExceptionTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import KMSInvalidStateExceptionTypeDef
def get_value() -> KMSInvalidStateExceptionTypeDef:
return {
"message": ...,
}
KMSNotFoundExceptionTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import KMSNotFoundExceptionTypeDef
def get_value() -> KMSNotFoundExceptionTypeDef:
return {
"message": ...,
}
KMSOptInRequiredTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import KMSOptInRequiredTypeDef
def get_value() -> KMSOptInRequiredTypeDef:
return {
"message": ...,
}
KMSThrottlingExceptionTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import KMSThrottlingExceptionTypeDef
def get_value() -> KMSThrottlingExceptionTypeDef:
return {
"message": ...,
}
ShardFilterTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ShardFilterTypeDef
def get_value() -> ShardFilterTypeDef:
return {
"Type": ...,
}
Definition
class ShardFilterTypeDef(TypedDict):
Type: ShardFilterTypeType, # (1)
ShardId: NotRequired[str],
Timestamp: NotRequired[Union[datetime, str]],
ListStreamConsumersInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ListStreamConsumersInputRequestTypeDef
def get_value() -> ListStreamConsumersInputRequestTypeDef:
return {
"StreamARN": ...,
}
Definition
class ListStreamConsumersInputRequestTypeDef(TypedDict):
StreamARN: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
StreamCreationTimestamp: NotRequired[Union[datetime, str]],
ListStreamsInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ListStreamsInputRequestTypeDef
def get_value() -> ListStreamsInputRequestTypeDef:
return {
"Limit": ...,
}
Definition
class ListStreamsInputRequestTypeDef(TypedDict):
Limit: NotRequired[int],
ExclusiveStartStreamName: NotRequired[str],
NextToken: NotRequired[str],
ListTagsForStreamInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ListTagsForStreamInputRequestTypeDef
def get_value() -> ListTagsForStreamInputRequestTypeDef:
return {
"StreamName": ...,
}
Definition
class ListTagsForStreamInputRequestTypeDef(TypedDict):
StreamName: NotRequired[str],
ExclusiveStartTagKey: NotRequired[str],
Limit: NotRequired[int],
StreamARN: NotRequired[str],
TagTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
MergeShardsInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import MergeShardsInputRequestTypeDef
def get_value() -> MergeShardsInputRequestTypeDef:
return {
"ShardToMerge": ...,
"AdjacentShardToMerge": ...,
}
Definition
class MergeShardsInputRequestTypeDef(TypedDict):
ShardToMerge: str,
AdjacentShardToMerge: str,
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
PutRecordInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import PutRecordInputRequestTypeDef
def get_value() -> PutRecordInputRequestTypeDef:
return {
"Data": ...,
"PartitionKey": ...,
}
Definition
class PutRecordInputRequestTypeDef(TypedDict):
Data: Union[str, bytes, IO[Any], StreamingBody],
PartitionKey: str,
StreamName: NotRequired[str],
ExplicitHashKey: NotRequired[str],
SequenceNumberForOrdering: NotRequired[str],
StreamARN: NotRequired[str],
PutRecordsRequestEntryTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import PutRecordsRequestEntryTypeDef
def get_value() -> PutRecordsRequestEntryTypeDef:
return {
"Data": ...,
"PartitionKey": ...,
}
Definition
class PutRecordsRequestEntryTypeDef(TypedDict):
Data: Union[str, bytes, IO[Any], StreamingBody],
PartitionKey: str,
ExplicitHashKey: NotRequired[str],
PutRecordsResultEntryTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import PutRecordsResultEntryTypeDef
def get_value() -> PutRecordsResultEntryTypeDef:
return {
"SequenceNumber": ...,
}
Definition
class PutRecordsResultEntryTypeDef(TypedDict):
SequenceNumber: NotRequired[str],
ShardId: NotRequired[str],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
RegisterStreamConsumerInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import RegisterStreamConsumerInputRequestTypeDef
def get_value() -> RegisterStreamConsumerInputRequestTypeDef:
return {
"StreamARN": ...,
"ConsumerName": ...,
}
Definition
class RegisterStreamConsumerInputRequestTypeDef(TypedDict):
StreamARN: str,
ConsumerName: str,
RemoveTagsFromStreamInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import RemoveTagsFromStreamInputRequestTypeDef
def get_value() -> RemoveTagsFromStreamInputRequestTypeDef:
return {
"TagKeys": ...,
}
Definition
class RemoveTagsFromStreamInputRequestTypeDef(TypedDict):
TagKeys: Sequence[str],
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
ResourceInUseExceptionTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ResourceInUseExceptionTypeDef
def get_value() -> ResourceInUseExceptionTypeDef:
return {
"message": ...,
}
ResourceNotFoundExceptionTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ResourceNotFoundExceptionTypeDef
def get_value() -> ResourceNotFoundExceptionTypeDef:
return {
"message": ...,
}
SequenceNumberRangeTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import SequenceNumberRangeTypeDef
def get_value() -> SequenceNumberRangeTypeDef:
return {
"StartingSequenceNumber": ...,
}
Definition
class SequenceNumberRangeTypeDef(TypedDict):
StartingSequenceNumber: str,
EndingSequenceNumber: NotRequired[str],
SplitShardInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import SplitShardInputRequestTypeDef
def get_value() -> SplitShardInputRequestTypeDef:
return {
"ShardToSplit": ...,
"NewStartingHashKey": ...,
}
Definition
class SplitShardInputRequestTypeDef(TypedDict):
ShardToSplit: str,
NewStartingHashKey: str,
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
StartStreamEncryptionInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import StartStreamEncryptionInputRequestTypeDef
def get_value() -> StartStreamEncryptionInputRequestTypeDef:
return {
"EncryptionType": ...,
"KeyId": ...,
}
Definition
class StartStreamEncryptionInputRequestTypeDef(TypedDict):
EncryptionType: EncryptionTypeType, # (1)
KeyId: str,
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
StartingPositionTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import StartingPositionTypeDef
def get_value() -> StartingPositionTypeDef:
return {
"Type": ...,
}
Definition
class StartingPositionTypeDef(TypedDict):
Type: ShardIteratorTypeType, # (1)
SequenceNumber: NotRequired[str],
Timestamp: NotRequired[Union[datetime, str]],
StopStreamEncryptionInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import StopStreamEncryptionInputRequestTypeDef
def get_value() -> StopStreamEncryptionInputRequestTypeDef:
return {
"EncryptionType": ...,
"KeyId": ...,
}
Definition
class StopStreamEncryptionInputRequestTypeDef(TypedDict):
EncryptionType: EncryptionTypeType, # (1)
KeyId: str,
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
UpdateShardCountInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import UpdateShardCountInputRequestTypeDef
def get_value() -> UpdateShardCountInputRequestTypeDef:
return {
"TargetShardCount": ...,
"ScalingType": ...,
}
Definition
class UpdateShardCountInputRequestTypeDef(TypedDict):
TargetShardCount: int,
ScalingType: ScalingTypeType, # (1)
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
- See ScalingTypeType
ChildShardTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ChildShardTypeDef
def get_value() -> ChildShardTypeDef:
return {
"ShardId": ...,
"ParentShards": ...,
"HashKeyRange": ...,
}
Definition
class ChildShardTypeDef(TypedDict):
ShardId: str,
ParentShards: List[str],
HashKeyRange: HashKeyRangeTypeDef, # (1)
CreateStreamInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import CreateStreamInputRequestTypeDef
def get_value() -> CreateStreamInputRequestTypeDef:
return {
"StreamName": ...,
}
Definition
class CreateStreamInputRequestTypeDef(TypedDict):
StreamName: str,
ShardCount: NotRequired[int],
StreamModeDetails: NotRequired[StreamModeDetailsTypeDef], # (1)
StreamSummaryTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import StreamSummaryTypeDef
def get_value() -> StreamSummaryTypeDef:
return {
"StreamName": ...,
"StreamARN": ...,
"StreamStatus": ...,
}
Definition
class StreamSummaryTypeDef(TypedDict):
StreamName: str,
StreamARN: str,
StreamStatus: StreamStatusType, # (1)
StreamModeDetails: NotRequired[StreamModeDetailsTypeDef], # (2)
StreamCreationTimestamp: NotRequired[datetime],
UpdateStreamModeInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import UpdateStreamModeInputRequestTypeDef
def get_value() -> UpdateStreamModeInputRequestTypeDef:
return {
"StreamARN": ...,
"StreamModeDetails": ...,
}
Definition
class UpdateStreamModeInputRequestTypeDef(TypedDict):
StreamARN: str,
StreamModeDetails: StreamModeDetailsTypeDef, # (1)
DescribeLimitsOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DescribeLimitsOutputTypeDef
def get_value() -> DescribeLimitsOutputTypeDef:
return {
"ShardLimit": ...,
"OpenShardCount": ...,
"OnDemandStreamCount": ...,
"OnDemandStreamCountLimit": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeLimitsOutputTypeDef(TypedDict):
ShardLimit: int,
OpenShardCount: int,
OnDemandStreamCount: int,
OnDemandStreamCountLimit: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeStreamConsumerOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DescribeStreamConsumerOutputTypeDef
def get_value() -> DescribeStreamConsumerOutputTypeDef:
return {
"ConsumerDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeStreamConsumerOutputTypeDef(TypedDict):
ConsumerDescription: ConsumerDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EmptyResponseMetadataTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EnhancedMonitoringOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import EnhancedMonitoringOutputTypeDef
def get_value() -> EnhancedMonitoringOutputTypeDef:
return {
"StreamName": ...,
"CurrentShardLevelMetrics": ...,
"DesiredShardLevelMetrics": ...,
"StreamARN": ...,
"ResponseMetadata": ...,
}
Definition
class EnhancedMonitoringOutputTypeDef(TypedDict):
StreamName: str,
CurrentShardLevelMetrics: List[MetricsNameType], # (1)
DesiredShardLevelMetrics: List[MetricsNameType], # (1)
StreamARN: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See MetricsNameType
- See MetricsNameType
- See ResponseMetadataTypeDef
GetShardIteratorOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import GetShardIteratorOutputTypeDef
def get_value() -> GetShardIteratorOutputTypeDef:
return {
"ShardIterator": ...,
"ResponseMetadata": ...,
}
Definition
class GetShardIteratorOutputTypeDef(TypedDict):
ShardIterator: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListStreamConsumersOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ListStreamConsumersOutputTypeDef
def get_value() -> ListStreamConsumersOutputTypeDef:
return {
"Consumers": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListStreamConsumersOutputTypeDef(TypedDict):
Consumers: List[ConsumerTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutRecordOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import PutRecordOutputTypeDef
def get_value() -> PutRecordOutputTypeDef:
return {
"ShardId": ...,
"SequenceNumber": ...,
"EncryptionType": ...,
"ResponseMetadata": ...,
}
Definition
class PutRecordOutputTypeDef(TypedDict):
ShardId: str,
SequenceNumber: str,
EncryptionType: EncryptionTypeType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RegisterStreamConsumerOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import RegisterStreamConsumerOutputTypeDef
def get_value() -> RegisterStreamConsumerOutputTypeDef:
return {
"Consumer": ...,
"ResponseMetadata": ...,
}
Definition
class RegisterStreamConsumerOutputTypeDef(TypedDict):
Consumer: ConsumerTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateShardCountOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import UpdateShardCountOutputTypeDef
def get_value() -> UpdateShardCountOutputTypeDef:
return {
"StreamName": ...,
"CurrentShardCount": ...,
"TargetShardCount": ...,
"StreamARN": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateShardCountOutputTypeDef(TypedDict):
StreamName: str,
CurrentShardCount: int,
TargetShardCount: int,
StreamARN: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeStreamInputDescribeStreamPaginateTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DescribeStreamInputDescribeStreamPaginateTypeDef
def get_value() -> DescribeStreamInputDescribeStreamPaginateTypeDef:
return {
"StreamName": ...,
}
Definition
class DescribeStreamInputDescribeStreamPaginateTypeDef(TypedDict):
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListStreamConsumersInputListStreamConsumersPaginateTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ListStreamConsumersInputListStreamConsumersPaginateTypeDef
def get_value() -> ListStreamConsumersInputListStreamConsumersPaginateTypeDef:
return {
"StreamARN": ...,
}
Definition
class ListStreamConsumersInputListStreamConsumersPaginateTypeDef(TypedDict):
StreamARN: str,
StreamCreationTimestamp: NotRequired[Union[datetime, str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListStreamsInputListStreamsPaginateTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ListStreamsInputListStreamsPaginateTypeDef
def get_value() -> ListStreamsInputListStreamsPaginateTypeDef:
return {
"ExclusiveStartStreamName": ...,
}
Definition
class ListStreamsInputListStreamsPaginateTypeDef(TypedDict):
ExclusiveStartStreamName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeStreamInputStreamExistsWaitTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DescribeStreamInputStreamExistsWaitTypeDef
def get_value() -> DescribeStreamInputStreamExistsWaitTypeDef:
return {
"StreamName": ...,
}
Definition
class DescribeStreamInputStreamExistsWaitTypeDef(TypedDict):
StreamName: NotRequired[str],
Limit: NotRequired[int],
ExclusiveStartShardId: NotRequired[str],
StreamARN: NotRequired[str],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeStreamInputStreamNotExistsWaitTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DescribeStreamInputStreamNotExistsWaitTypeDef
def get_value() -> DescribeStreamInputStreamNotExistsWaitTypeDef:
return {
"StreamName": ...,
}
Definition
class DescribeStreamInputStreamNotExistsWaitTypeDef(TypedDict):
StreamName: NotRequired[str],
Limit: NotRequired[int],
ExclusiveStartShardId: NotRequired[str],
StreamARN: NotRequired[str],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
StreamDescriptionSummaryTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import StreamDescriptionSummaryTypeDef
def get_value() -> StreamDescriptionSummaryTypeDef:
return {
"StreamName": ...,
"StreamARN": ...,
"StreamStatus": ...,
"RetentionPeriodHours": ...,
"StreamCreationTimestamp": ...,
"EnhancedMonitoring": ...,
"OpenShardCount": ...,
}
Definition
class StreamDescriptionSummaryTypeDef(TypedDict):
StreamName: str,
StreamARN: str,
StreamStatus: StreamStatusType, # (1)
RetentionPeriodHours: int,
StreamCreationTimestamp: datetime,
EnhancedMonitoring: List[EnhancedMetricsTypeDef], # (3)
OpenShardCount: int,
StreamModeDetails: NotRequired[StreamModeDetailsTypeDef], # (2)
EncryptionType: NotRequired[EncryptionTypeType], # (4)
KeyId: NotRequired[str],
ConsumerCount: NotRequired[int],
ListShardsInputListShardsPaginateTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ListShardsInputListShardsPaginateTypeDef
def get_value() -> ListShardsInputListShardsPaginateTypeDef:
return {
"StreamName": ...,
}
Definition
class ListShardsInputListShardsPaginateTypeDef(TypedDict):
StreamName: NotRequired[str],
ExclusiveStartShardId: NotRequired[str],
StreamCreationTimestamp: NotRequired[Union[datetime, str]],
ShardFilter: NotRequired[ShardFilterTypeDef], # (1)
StreamARN: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListShardsInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ListShardsInputRequestTypeDef
def get_value() -> ListShardsInputRequestTypeDef:
return {
"StreamName": ...,
}
Definition
class ListShardsInputRequestTypeDef(TypedDict):
StreamName: NotRequired[str],
NextToken: NotRequired[str],
ExclusiveStartShardId: NotRequired[str],
MaxResults: NotRequired[int],
StreamCreationTimestamp: NotRequired[Union[datetime, str]],
ShardFilter: NotRequired[ShardFilterTypeDef], # (1)
StreamARN: NotRequired[str],
ListTagsForStreamOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ListTagsForStreamOutputTypeDef
def get_value() -> ListTagsForStreamOutputTypeDef:
return {
"Tags": ...,
"HasMoreTags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForStreamOutputTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
HasMoreTags: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
PutRecordsInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import PutRecordsInputRequestTypeDef
def get_value() -> PutRecordsInputRequestTypeDef:
return {
"Records": ...,
}
Definition
class PutRecordsInputRequestTypeDef(TypedDict):
Records: Sequence[PutRecordsRequestEntryTypeDef], # (1)
StreamName: NotRequired[str],
StreamARN: NotRequired[str],
PutRecordsOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import PutRecordsOutputTypeDef
def get_value() -> PutRecordsOutputTypeDef:
return {
"FailedRecordCount": ...,
"Records": ...,
"EncryptionType": ...,
"ResponseMetadata": ...,
}
Definition
class PutRecordsOutputTypeDef(TypedDict):
FailedRecordCount: int,
Records: List[PutRecordsResultEntryTypeDef], # (1)
EncryptionType: EncryptionTypeType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ShardTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ShardTypeDef
def get_value() -> ShardTypeDef:
return {
"ShardId": ...,
"HashKeyRange": ...,
"SequenceNumberRange": ...,
}
Definition
class ShardTypeDef(TypedDict):
ShardId: str,
HashKeyRange: HashKeyRangeTypeDef, # (1)
SequenceNumberRange: SequenceNumberRangeTypeDef, # (2)
ParentShardId: NotRequired[str],
AdjacentParentShardId: NotRequired[str],
SubscribeToShardInputRequestTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import SubscribeToShardInputRequestTypeDef
def get_value() -> SubscribeToShardInputRequestTypeDef:
return {
"ConsumerARN": ...,
"ShardId": ...,
"StartingPosition": ...,
}
Definition
class SubscribeToShardInputRequestTypeDef(TypedDict):
ConsumerARN: str,
ShardId: str,
StartingPosition: StartingPositionTypeDef, # (1)
GetRecordsOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import GetRecordsOutputTypeDef
def get_value() -> GetRecordsOutputTypeDef:
return {
"Records": ...,
"NextShardIterator": ...,
"MillisBehindLatest": ...,
"ChildShards": ...,
"ResponseMetadata": ...,
}
Definition
class GetRecordsOutputTypeDef(TypedDict):
Records: List[RecordTypeDef], # (1)
NextShardIterator: str,
MillisBehindLatest: int,
ChildShards: List[ChildShardTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See RecordTypeDef
- See ChildShardTypeDef
- See ResponseMetadataTypeDef
SubscribeToShardEventTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import SubscribeToShardEventTypeDef
def get_value() -> SubscribeToShardEventTypeDef:
return {
"Records": ...,
"ContinuationSequenceNumber": ...,
"MillisBehindLatest": ...,
}
Definition
class SubscribeToShardEventTypeDef(TypedDict):
Records: List[RecordTypeDef], # (1)
ContinuationSequenceNumber: str,
MillisBehindLatest: int,
ChildShards: NotRequired[List[ChildShardTypeDef]], # (2)
- See RecordTypeDef
- See ChildShardTypeDef
ListStreamsOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ListStreamsOutputTypeDef
def get_value() -> ListStreamsOutputTypeDef:
return {
"StreamNames": ...,
"HasMoreStreams": ...,
"NextToken": ...,
"StreamSummaries": ...,
"ResponseMetadata": ...,
}
Definition
class ListStreamsOutputTypeDef(TypedDict):
StreamNames: List[str],
HasMoreStreams: bool,
NextToken: str,
StreamSummaries: List[StreamSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeStreamSummaryOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DescribeStreamSummaryOutputTypeDef
def get_value() -> DescribeStreamSummaryOutputTypeDef:
return {
"StreamDescriptionSummary": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeStreamSummaryOutputTypeDef(TypedDict):
StreamDescriptionSummary: StreamDescriptionSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListShardsOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import ListShardsOutputTypeDef
def get_value() -> ListShardsOutputTypeDef:
return {
"Shards": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListShardsOutputTypeDef(TypedDict):
Shards: List[ShardTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See ShardTypeDef
- See ResponseMetadataTypeDef
StreamDescriptionTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import StreamDescriptionTypeDef
def get_value() -> StreamDescriptionTypeDef:
return {
"StreamName": ...,
"StreamARN": ...,
"StreamStatus": ...,
"Shards": ...,
"HasMoreShards": ...,
"RetentionPeriodHours": ...,
"StreamCreationTimestamp": ...,
"EnhancedMonitoring": ...,
}
Definition
class StreamDescriptionTypeDef(TypedDict):
StreamName: str,
StreamARN: str,
StreamStatus: StreamStatusType, # (1)
Shards: List[ShardTypeDef], # (3)
HasMoreShards: bool,
RetentionPeriodHours: int,
StreamCreationTimestamp: datetime,
EnhancedMonitoring: List[EnhancedMetricsTypeDef], # (4)
StreamModeDetails: NotRequired[StreamModeDetailsTypeDef], # (2)
EncryptionType: NotRequired[EncryptionTypeType], # (5)
KeyId: NotRequired[str],
- See StreamStatusType
- See StreamModeDetailsTypeDef
- See ShardTypeDef
- See EnhancedMetricsTypeDef
- See EncryptionTypeType
SubscribeToShardEventStreamTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import SubscribeToShardEventStreamTypeDef
def get_value() -> SubscribeToShardEventStreamTypeDef:
return {
"SubscribeToShardEvent": ...,
}
Definition
class SubscribeToShardEventStreamTypeDef(TypedDict):
SubscribeToShardEvent: SubscribeToShardEventTypeDef, # (1)
ResourceNotFoundException: NotRequired[ResourceNotFoundExceptionTypeDef], # (2)
ResourceInUseException: NotRequired[ResourceInUseExceptionTypeDef], # (3)
KMSDisabledException: NotRequired[KMSDisabledExceptionTypeDef], # (4)
KMSInvalidStateException: NotRequired[KMSInvalidStateExceptionTypeDef], # (5)
KMSAccessDeniedException: NotRequired[KMSAccessDeniedExceptionTypeDef], # (6)
KMSNotFoundException: NotRequired[KMSNotFoundExceptionTypeDef], # (7)
KMSOptInRequired: NotRequired[KMSOptInRequiredTypeDef], # (8)
KMSThrottlingException: NotRequired[KMSThrottlingExceptionTypeDef], # (9)
InternalFailureException: NotRequired[InternalFailureExceptionTypeDef], # (10)
- See SubscribeToShardEventTypeDef
- See ResourceNotFoundExceptionTypeDef
- See ResourceInUseExceptionTypeDef
- See KMSDisabledExceptionTypeDef
- See KMSInvalidStateExceptionTypeDef
- See KMSAccessDeniedExceptionTypeDef
- See KMSNotFoundExceptionTypeDef
- See KMSOptInRequiredTypeDef
- See KMSThrottlingExceptionTypeDef
- See InternalFailureExceptionTypeDef
DescribeStreamOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import DescribeStreamOutputTypeDef
def get_value() -> DescribeStreamOutputTypeDef:
return {
"StreamDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeStreamOutputTypeDef(TypedDict):
StreamDescription: StreamDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SubscribeToShardOutputTypeDef
Usage Example
from mypy_boto3_kinesis.type_defs import SubscribeToShardOutputTypeDef
def get_value() -> SubscribeToShardOutputTypeDef:
return {
"EventStream": ...,
"ResponseMetadata": ...,
}