Skip to content

Typed dictionaries#

Index > Kinesis > Typed dictionaries

Auto-generated documentation for Kinesis type annotations stubs module mypy-boto3-kinesis.

AddTagsToStreamInputRequestTypeDef#

# AddTagsToStreamInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import AddTagsToStreamInputRequestTypeDef

def get_value() -> AddTagsToStreamInputRequestTypeDef:
    return {
        "Tags": ...,
    }
# AddTagsToStreamInputRequestTypeDef definition

class AddTagsToStreamInputRequestTypeDef(TypedDict):
    Tags: Mapping[str, str],
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

HashKeyRangeTypeDef#

# HashKeyRangeTypeDef usage example

from mypy_boto3_kinesis.type_defs import HashKeyRangeTypeDef

def get_value() -> HashKeyRangeTypeDef:
    return {
        "StartingHashKey": ...,
        "EndingHashKey": ...,
    }
# HashKeyRangeTypeDef definition

class HashKeyRangeTypeDef(TypedDict):
    StartingHashKey: str,
    EndingHashKey: str,

ConsumerDescriptionTypeDef#

# ConsumerDescriptionTypeDef usage example

from mypy_boto3_kinesis.type_defs import ConsumerDescriptionTypeDef

def get_value() -> ConsumerDescriptionTypeDef:
    return {
        "ConsumerName": ...,
        "ConsumerARN": ...,
        "ConsumerStatus": ...,
        "ConsumerCreationTimestamp": ...,
        "StreamARN": ...,
    }
# ConsumerDescriptionTypeDef definition

class ConsumerDescriptionTypeDef(TypedDict):
    ConsumerName: str,
    ConsumerARN: str,
    ConsumerStatus: ConsumerStatusType,  # (1)
    ConsumerCreationTimestamp: datetime,
    StreamARN: str,
  1. See ConsumerStatusType

ConsumerTypeDef#

# ConsumerTypeDef usage example

from mypy_boto3_kinesis.type_defs import ConsumerTypeDef

def get_value() -> ConsumerTypeDef:
    return {
        "ConsumerName": ...,
        "ConsumerARN": ...,
        "ConsumerStatus": ...,
        "ConsumerCreationTimestamp": ...,
    }
# ConsumerTypeDef definition

class ConsumerTypeDef(TypedDict):
    ConsumerName: str,
    ConsumerARN: str,
    ConsumerStatus: ConsumerStatusType,  # (1)
    ConsumerCreationTimestamp: datetime,
  1. See ConsumerStatusType

StreamModeDetailsTypeDef#

# StreamModeDetailsTypeDef usage example

from mypy_boto3_kinesis.type_defs import StreamModeDetailsTypeDef

def get_value() -> StreamModeDetailsTypeDef:
    return {
        "StreamMode": ...,
    }
# StreamModeDetailsTypeDef definition

class StreamModeDetailsTypeDef(TypedDict):
    StreamMode: StreamModeType,  # (1)
  1. See StreamModeType

DecreaseStreamRetentionPeriodInputRequestTypeDef#

# DecreaseStreamRetentionPeriodInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import DecreaseStreamRetentionPeriodInputRequestTypeDef

def get_value() -> DecreaseStreamRetentionPeriodInputRequestTypeDef:
    return {
        "RetentionPeriodHours": ...,
    }
# DecreaseStreamRetentionPeriodInputRequestTypeDef definition

class DecreaseStreamRetentionPeriodInputRequestTypeDef(TypedDict):
    RetentionPeriodHours: int,
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

DeleteStreamInputRequestTypeDef#

# DeleteStreamInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import DeleteStreamInputRequestTypeDef

def get_value() -> DeleteStreamInputRequestTypeDef:
    return {
        "StreamName": ...,
    }
# DeleteStreamInputRequestTypeDef definition

class DeleteStreamInputRequestTypeDef(TypedDict):
    StreamName: NotRequired[str],
    EnforceConsumerDeletion: NotRequired[bool],
    StreamARN: NotRequired[str],

DeregisterStreamConsumerInputRequestTypeDef#

# DeregisterStreamConsumerInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import DeregisterStreamConsumerInputRequestTypeDef

def get_value() -> DeregisterStreamConsumerInputRequestTypeDef:
    return {
        "StreamARN": ...,
    }
# DeregisterStreamConsumerInputRequestTypeDef definition

class DeregisterStreamConsumerInputRequestTypeDef(TypedDict):
    StreamARN: NotRequired[str],
    ConsumerName: NotRequired[str],
    ConsumerARN: NotRequired[str],

DescribeLimitsOutputTypeDef#

# DescribeLimitsOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import DescribeLimitsOutputTypeDef

def get_value() -> DescribeLimitsOutputTypeDef:
    return {
        "ShardLimit": ...,
        "OpenShardCount": ...,
        "OnDemandStreamCount": ...,
        "OnDemandStreamCountLimit": ...,
        "ResponseMetadata": ...,
    }
# DescribeLimitsOutputTypeDef definition

class DescribeLimitsOutputTypeDef(TypedDict):
    ShardLimit: int,
    OpenShardCount: int,
    OnDemandStreamCount: int,
    OnDemandStreamCountLimit: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeStreamConsumerInputRequestTypeDef#

# DescribeStreamConsumerInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import DescribeStreamConsumerInputRequestTypeDef

def get_value() -> DescribeStreamConsumerInputRequestTypeDef:
    return {
        "StreamARN": ...,
    }
# DescribeStreamConsumerInputRequestTypeDef definition

class DescribeStreamConsumerInputRequestTypeDef(TypedDict):
    StreamARN: NotRequired[str],
    ConsumerName: NotRequired[str],
    ConsumerARN: NotRequired[str],

DescribeStreamInputDescribeStreamPaginateTypeDef#

# DescribeStreamInputDescribeStreamPaginateTypeDef usage example

from mypy_boto3_kinesis.type_defs import DescribeStreamInputDescribeStreamPaginateTypeDef

def get_value() -> DescribeStreamInputDescribeStreamPaginateTypeDef:
    return {
        "StreamName": ...,
    }
# DescribeStreamInputDescribeStreamPaginateTypeDef definition

class DescribeStreamInputDescribeStreamPaginateTypeDef(TypedDict):
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeStreamInputRequestTypeDef#

# DescribeStreamInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import DescribeStreamInputRequestTypeDef

def get_value() -> DescribeStreamInputRequestTypeDef:
    return {
        "StreamName": ...,
    }
# DescribeStreamInputRequestTypeDef definition

class DescribeStreamInputRequestTypeDef(TypedDict):
    StreamName: NotRequired[str],
    Limit: NotRequired[int],
    ExclusiveStartShardId: NotRequired[str],
    StreamARN: NotRequired[str],

WaiterConfigTypeDef#

# WaiterConfigTypeDef usage example

from mypy_boto3_kinesis.type_defs import WaiterConfigTypeDef

def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }
# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeStreamSummaryInputRequestTypeDef#

# DescribeStreamSummaryInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import DescribeStreamSummaryInputRequestTypeDef

def get_value() -> DescribeStreamSummaryInputRequestTypeDef:
    return {
        "StreamName": ...,
    }
# DescribeStreamSummaryInputRequestTypeDef definition

class DescribeStreamSummaryInputRequestTypeDef(TypedDict):
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

DisableEnhancedMonitoringInputRequestTypeDef#

# DisableEnhancedMonitoringInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import DisableEnhancedMonitoringInputRequestTypeDef

def get_value() -> DisableEnhancedMonitoringInputRequestTypeDef:
    return {
        "ShardLevelMetrics": ...,
    }
# DisableEnhancedMonitoringInputRequestTypeDef definition

class DisableEnhancedMonitoringInputRequestTypeDef(TypedDict):
    ShardLevelMetrics: Sequence[MetricsNameType],  # (1)
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
  1. See MetricsNameType

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_kinesis.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EnableEnhancedMonitoringInputRequestTypeDef#

# EnableEnhancedMonitoringInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import EnableEnhancedMonitoringInputRequestTypeDef

def get_value() -> EnableEnhancedMonitoringInputRequestTypeDef:
    return {
        "ShardLevelMetrics": ...,
    }
# EnableEnhancedMonitoringInputRequestTypeDef definition

class EnableEnhancedMonitoringInputRequestTypeDef(TypedDict):
    ShardLevelMetrics: Sequence[MetricsNameType],  # (1)
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
  1. See MetricsNameType

EnhancedMetricsTypeDef#

# EnhancedMetricsTypeDef usage example

from mypy_boto3_kinesis.type_defs import EnhancedMetricsTypeDef

def get_value() -> EnhancedMetricsTypeDef:
    return {
        "ShardLevelMetrics": ...,
    }
# EnhancedMetricsTypeDef definition

class EnhancedMetricsTypeDef(TypedDict):
    ShardLevelMetrics: NotRequired[List[MetricsNameType]],  # (1)
  1. See MetricsNameType

EnhancedMonitoringOutputTypeDef#

# EnhancedMonitoringOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import EnhancedMonitoringOutputTypeDef

def get_value() -> EnhancedMonitoringOutputTypeDef:
    return {
        "StreamName": ...,
        "CurrentShardLevelMetrics": ...,
        "DesiredShardLevelMetrics": ...,
        "StreamARN": ...,
        "ResponseMetadata": ...,
    }
# EnhancedMonitoringOutputTypeDef definition

class EnhancedMonitoringOutputTypeDef(TypedDict):
    StreamName: str,
    CurrentShardLevelMetrics: List[MetricsNameType],  # (1)
    DesiredShardLevelMetrics: List[MetricsNameType],  # (1)
    StreamARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See MetricsNameType
  2. See MetricsNameType
  3. See ResponseMetadataTypeDef

GetRecordsInputRequestTypeDef#

# GetRecordsInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import GetRecordsInputRequestTypeDef

def get_value() -> GetRecordsInputRequestTypeDef:
    return {
        "ShardIterator": ...,
    }
# GetRecordsInputRequestTypeDef definition

class GetRecordsInputRequestTypeDef(TypedDict):
    ShardIterator: str,
    Limit: NotRequired[int],
    StreamARN: NotRequired[str],

RecordTypeDef#

# RecordTypeDef usage example

from mypy_boto3_kinesis.type_defs import RecordTypeDef

def get_value() -> RecordTypeDef:
    return {
        "SequenceNumber": ...,
        "Data": ...,
        "PartitionKey": ...,
    }
# RecordTypeDef definition

class RecordTypeDef(TypedDict):
    SequenceNumber: str,
    Data: bytes,
    PartitionKey: str,
    ApproximateArrivalTimestamp: NotRequired[datetime],
    EncryptionType: NotRequired[EncryptionTypeType],  # (1)
  1. See EncryptionTypeType

GetShardIteratorInputRequestTypeDef#

# GetShardIteratorInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import GetShardIteratorInputRequestTypeDef

def get_value() -> GetShardIteratorInputRequestTypeDef:
    return {
        "ShardId": ...,
        "ShardIteratorType": ...,
    }
# GetShardIteratorInputRequestTypeDef definition

class GetShardIteratorInputRequestTypeDef(TypedDict):
    ShardId: str,
    ShardIteratorType: ShardIteratorTypeType,  # (1)
    StreamName: NotRequired[str],
    StartingSequenceNumber: NotRequired[str],
    Timestamp: NotRequired[Union[datetime, str]],
    StreamARN: NotRequired[str],
  1. See ShardIteratorTypeType

GetShardIteratorOutputTypeDef#

# GetShardIteratorOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import GetShardIteratorOutputTypeDef

def get_value() -> GetShardIteratorOutputTypeDef:
    return {
        "ShardIterator": ...,
        "ResponseMetadata": ...,
    }
# GetShardIteratorOutputTypeDef definition

class GetShardIteratorOutputTypeDef(TypedDict):
    ShardIterator: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

IncreaseStreamRetentionPeriodInputRequestTypeDef#

# IncreaseStreamRetentionPeriodInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import IncreaseStreamRetentionPeriodInputRequestTypeDef

def get_value() -> IncreaseStreamRetentionPeriodInputRequestTypeDef:
    return {
        "RetentionPeriodHours": ...,
    }
# IncreaseStreamRetentionPeriodInputRequestTypeDef definition

class IncreaseStreamRetentionPeriodInputRequestTypeDef(TypedDict):
    RetentionPeriodHours: int,
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

InternalFailureExceptionTypeDef#

# InternalFailureExceptionTypeDef usage example

from mypy_boto3_kinesis.type_defs import InternalFailureExceptionTypeDef

def get_value() -> InternalFailureExceptionTypeDef:
    return {
        "message": ...,
    }
# InternalFailureExceptionTypeDef definition

class InternalFailureExceptionTypeDef(TypedDict):
    message: NotRequired[str],

KMSAccessDeniedExceptionTypeDef#

# KMSAccessDeniedExceptionTypeDef usage example

from mypy_boto3_kinesis.type_defs import KMSAccessDeniedExceptionTypeDef

def get_value() -> KMSAccessDeniedExceptionTypeDef:
    return {
        "message": ...,
    }
# KMSAccessDeniedExceptionTypeDef definition

class KMSAccessDeniedExceptionTypeDef(TypedDict):
    message: NotRequired[str],

KMSDisabledExceptionTypeDef#

# KMSDisabledExceptionTypeDef usage example

from mypy_boto3_kinesis.type_defs import KMSDisabledExceptionTypeDef

def get_value() -> KMSDisabledExceptionTypeDef:
    return {
        "message": ...,
    }
# KMSDisabledExceptionTypeDef definition

class KMSDisabledExceptionTypeDef(TypedDict):
    message: NotRequired[str],

KMSInvalidStateExceptionTypeDef#

# KMSInvalidStateExceptionTypeDef usage example

from mypy_boto3_kinesis.type_defs import KMSInvalidStateExceptionTypeDef

def get_value() -> KMSInvalidStateExceptionTypeDef:
    return {
        "message": ...,
    }
# KMSInvalidStateExceptionTypeDef definition

class KMSInvalidStateExceptionTypeDef(TypedDict):
    message: NotRequired[str],

KMSNotFoundExceptionTypeDef#

# KMSNotFoundExceptionTypeDef usage example

from mypy_boto3_kinesis.type_defs import KMSNotFoundExceptionTypeDef

def get_value() -> KMSNotFoundExceptionTypeDef:
    return {
        "message": ...,
    }
# KMSNotFoundExceptionTypeDef definition

class KMSNotFoundExceptionTypeDef(TypedDict):
    message: NotRequired[str],

KMSOptInRequiredTypeDef#

# KMSOptInRequiredTypeDef usage example

from mypy_boto3_kinesis.type_defs import KMSOptInRequiredTypeDef

def get_value() -> KMSOptInRequiredTypeDef:
    return {
        "message": ...,
    }
# KMSOptInRequiredTypeDef definition

class KMSOptInRequiredTypeDef(TypedDict):
    message: NotRequired[str],

KMSThrottlingExceptionTypeDef#

# KMSThrottlingExceptionTypeDef usage example

from mypy_boto3_kinesis.type_defs import KMSThrottlingExceptionTypeDef

def get_value() -> KMSThrottlingExceptionTypeDef:
    return {
        "message": ...,
    }
# KMSThrottlingExceptionTypeDef definition

class KMSThrottlingExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ShardFilterTypeDef#

# ShardFilterTypeDef usage example

from mypy_boto3_kinesis.type_defs import ShardFilterTypeDef

def get_value() -> ShardFilterTypeDef:
    return {
        "Type": ...,
    }
# ShardFilterTypeDef definition

class ShardFilterTypeDef(TypedDict):
    Type: ShardFilterTypeType,  # (1)
    ShardId: NotRequired[str],
    Timestamp: NotRequired[Union[datetime, str]],
  1. See ShardFilterTypeType

ListStreamConsumersInputListStreamConsumersPaginateTypeDef#

# ListStreamConsumersInputListStreamConsumersPaginateTypeDef usage example

from mypy_boto3_kinesis.type_defs import ListStreamConsumersInputListStreamConsumersPaginateTypeDef

def get_value() -> ListStreamConsumersInputListStreamConsumersPaginateTypeDef:
    return {
        "StreamARN": ...,
    }
# ListStreamConsumersInputListStreamConsumersPaginateTypeDef definition

class ListStreamConsumersInputListStreamConsumersPaginateTypeDef(TypedDict):
    StreamARN: str,
    StreamCreationTimestamp: NotRequired[Union[datetime, str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListStreamConsumersInputRequestTypeDef#

# ListStreamConsumersInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import ListStreamConsumersInputRequestTypeDef

def get_value() -> ListStreamConsumersInputRequestTypeDef:
    return {
        "StreamARN": ...,
    }
# ListStreamConsumersInputRequestTypeDef definition

class ListStreamConsumersInputRequestTypeDef(TypedDict):
    StreamARN: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    StreamCreationTimestamp: NotRequired[Union[datetime, str]],

ListStreamsInputListStreamsPaginateTypeDef#

# ListStreamsInputListStreamsPaginateTypeDef usage example

from mypy_boto3_kinesis.type_defs import ListStreamsInputListStreamsPaginateTypeDef

def get_value() -> ListStreamsInputListStreamsPaginateTypeDef:
    return {
        "ExclusiveStartStreamName": ...,
    }
# ListStreamsInputListStreamsPaginateTypeDef definition

class ListStreamsInputListStreamsPaginateTypeDef(TypedDict):
    ExclusiveStartStreamName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListStreamsInputRequestTypeDef#

# ListStreamsInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import ListStreamsInputRequestTypeDef

def get_value() -> ListStreamsInputRequestTypeDef:
    return {
        "Limit": ...,
    }
# ListStreamsInputRequestTypeDef definition

class ListStreamsInputRequestTypeDef(TypedDict):
    Limit: NotRequired[int],
    ExclusiveStartStreamName: NotRequired[str],
    NextToken: NotRequired[str],

ListTagsForStreamInputRequestTypeDef#

# ListTagsForStreamInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import ListTagsForStreamInputRequestTypeDef

def get_value() -> ListTagsForStreamInputRequestTypeDef:
    return {
        "StreamName": ...,
    }
# ListTagsForStreamInputRequestTypeDef definition

class ListTagsForStreamInputRequestTypeDef(TypedDict):
    StreamName: NotRequired[str],
    ExclusiveStartTagKey: NotRequired[str],
    Limit: NotRequired[int],
    StreamARN: NotRequired[str],

TagTypeDef#

# TagTypeDef usage example

from mypy_boto3_kinesis.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }
# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: NotRequired[str],

MergeShardsInputRequestTypeDef#

# MergeShardsInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import MergeShardsInputRequestTypeDef

def get_value() -> MergeShardsInputRequestTypeDef:
    return {
        "ShardToMerge": ...,
        "AdjacentShardToMerge": ...,
    }
# MergeShardsInputRequestTypeDef definition

class MergeShardsInputRequestTypeDef(TypedDict):
    ShardToMerge: str,
    AdjacentShardToMerge: str,
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_kinesis.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

PutRecordInputRequestTypeDef#

# PutRecordInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import PutRecordInputRequestTypeDef

def get_value() -> PutRecordInputRequestTypeDef:
    return {
        "Data": ...,
        "PartitionKey": ...,
    }
# PutRecordInputRequestTypeDef 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],

PutRecordOutputTypeDef#

# PutRecordOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import PutRecordOutputTypeDef

def get_value() -> PutRecordOutputTypeDef:
    return {
        "ShardId": ...,
        "SequenceNumber": ...,
        "EncryptionType": ...,
        "ResponseMetadata": ...,
    }
# PutRecordOutputTypeDef definition

class PutRecordOutputTypeDef(TypedDict):
    ShardId: str,
    SequenceNumber: str,
    EncryptionType: EncryptionTypeType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EncryptionTypeType
  2. See ResponseMetadataTypeDef

PutRecordsRequestEntryTypeDef#

# PutRecordsRequestEntryTypeDef usage example

from mypy_boto3_kinesis.type_defs import PutRecordsRequestEntryTypeDef

def get_value() -> PutRecordsRequestEntryTypeDef:
    return {
        "Data": ...,
        "PartitionKey": ...,
    }
# PutRecordsRequestEntryTypeDef definition

class PutRecordsRequestEntryTypeDef(TypedDict):
    Data: Union[str, bytes, IO[Any], StreamingBody],
    PartitionKey: str,
    ExplicitHashKey: NotRequired[str],

PutRecordsResultEntryTypeDef#

# PutRecordsResultEntryTypeDef usage example

from mypy_boto3_kinesis.type_defs import PutRecordsResultEntryTypeDef

def get_value() -> PutRecordsResultEntryTypeDef:
    return {
        "SequenceNumber": ...,
    }
# PutRecordsResultEntryTypeDef definition

class PutRecordsResultEntryTypeDef(TypedDict):
    SequenceNumber: NotRequired[str],
    ShardId: NotRequired[str],
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

RegisterStreamConsumerInputRequestTypeDef#

# RegisterStreamConsumerInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import RegisterStreamConsumerInputRequestTypeDef

def get_value() -> RegisterStreamConsumerInputRequestTypeDef:
    return {
        "StreamARN": ...,
        "ConsumerName": ...,
    }
# RegisterStreamConsumerInputRequestTypeDef definition

class RegisterStreamConsumerInputRequestTypeDef(TypedDict):
    StreamARN: str,
    ConsumerName: str,

RemoveTagsFromStreamInputRequestTypeDef#

# RemoveTagsFromStreamInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import RemoveTagsFromStreamInputRequestTypeDef

def get_value() -> RemoveTagsFromStreamInputRequestTypeDef:
    return {
        "TagKeys": ...,
    }
# RemoveTagsFromStreamInputRequestTypeDef definition

class RemoveTagsFromStreamInputRequestTypeDef(TypedDict):
    TagKeys: Sequence[str],
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

ResourceInUseExceptionTypeDef#

# ResourceInUseExceptionTypeDef usage example

from mypy_boto3_kinesis.type_defs import ResourceInUseExceptionTypeDef

def get_value() -> ResourceInUseExceptionTypeDef:
    return {
        "message": ...,
    }
# ResourceInUseExceptionTypeDef definition

class ResourceInUseExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ResourceNotFoundExceptionTypeDef#

# ResourceNotFoundExceptionTypeDef usage example

from mypy_boto3_kinesis.type_defs import ResourceNotFoundExceptionTypeDef

def get_value() -> ResourceNotFoundExceptionTypeDef:
    return {
        "message": ...,
    }
# ResourceNotFoundExceptionTypeDef definition

class ResourceNotFoundExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_kinesis.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

SequenceNumberRangeTypeDef#

# SequenceNumberRangeTypeDef usage example

from mypy_boto3_kinesis.type_defs import SequenceNumberRangeTypeDef

def get_value() -> SequenceNumberRangeTypeDef:
    return {
        "StartingSequenceNumber": ...,
    }
# SequenceNumberRangeTypeDef definition

class SequenceNumberRangeTypeDef(TypedDict):
    StartingSequenceNumber: str,
    EndingSequenceNumber: NotRequired[str],

SplitShardInputRequestTypeDef#

# SplitShardInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import SplitShardInputRequestTypeDef

def get_value() -> SplitShardInputRequestTypeDef:
    return {
        "ShardToSplit": ...,
        "NewStartingHashKey": ...,
    }
# SplitShardInputRequestTypeDef definition

class SplitShardInputRequestTypeDef(TypedDict):
    ShardToSplit: str,
    NewStartingHashKey: str,
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],

StartStreamEncryptionInputRequestTypeDef#

# StartStreamEncryptionInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import StartStreamEncryptionInputRequestTypeDef

def get_value() -> StartStreamEncryptionInputRequestTypeDef:
    return {
        "EncryptionType": ...,
        "KeyId": ...,
    }
# StartStreamEncryptionInputRequestTypeDef definition

class StartStreamEncryptionInputRequestTypeDef(TypedDict):
    EncryptionType: EncryptionTypeType,  # (1)
    KeyId: str,
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
  1. See EncryptionTypeType

StartingPositionTypeDef#

# StartingPositionTypeDef usage example

from mypy_boto3_kinesis.type_defs import StartingPositionTypeDef

def get_value() -> StartingPositionTypeDef:
    return {
        "Type": ...,
    }
# StartingPositionTypeDef definition

class StartingPositionTypeDef(TypedDict):
    Type: ShardIteratorTypeType,  # (1)
    SequenceNumber: NotRequired[str],
    Timestamp: NotRequired[Union[datetime, str]],
  1. See ShardIteratorTypeType

StopStreamEncryptionInputRequestTypeDef#

# StopStreamEncryptionInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import StopStreamEncryptionInputRequestTypeDef

def get_value() -> StopStreamEncryptionInputRequestTypeDef:
    return {
        "EncryptionType": ...,
        "KeyId": ...,
    }
# StopStreamEncryptionInputRequestTypeDef definition

class StopStreamEncryptionInputRequestTypeDef(TypedDict):
    EncryptionType: EncryptionTypeType,  # (1)
    KeyId: str,
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
  1. See EncryptionTypeType

UpdateShardCountInputRequestTypeDef#

# UpdateShardCountInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import UpdateShardCountInputRequestTypeDef

def get_value() -> UpdateShardCountInputRequestTypeDef:
    return {
        "TargetShardCount": ...,
        "ScalingType": ...,
    }
# UpdateShardCountInputRequestTypeDef definition

class UpdateShardCountInputRequestTypeDef(TypedDict):
    TargetShardCount: int,
    ScalingType: ScalingTypeType,  # (1)
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
  1. See ScalingTypeType

UpdateShardCountOutputTypeDef#

# UpdateShardCountOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import UpdateShardCountOutputTypeDef

def get_value() -> UpdateShardCountOutputTypeDef:
    return {
        "StreamName": ...,
        "CurrentShardCount": ...,
        "TargetShardCount": ...,
        "StreamARN": ...,
        "ResponseMetadata": ...,
    }
# UpdateShardCountOutputTypeDef definition

class UpdateShardCountOutputTypeDef(TypedDict):
    StreamName: str,
    CurrentShardCount: int,
    TargetShardCount: int,
    StreamARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ChildShardTypeDef#

# ChildShardTypeDef usage example

from mypy_boto3_kinesis.type_defs import ChildShardTypeDef

def get_value() -> ChildShardTypeDef:
    return {
        "ShardId": ...,
        "ParentShards": ...,
        "HashKeyRange": ...,
    }
# ChildShardTypeDef definition

class ChildShardTypeDef(TypedDict):
    ShardId: str,
    ParentShards: List[str],
    HashKeyRange: HashKeyRangeTypeDef,  # (1)
  1. See HashKeyRangeTypeDef

DescribeStreamConsumerOutputTypeDef#

# DescribeStreamConsumerOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import DescribeStreamConsumerOutputTypeDef

def get_value() -> DescribeStreamConsumerOutputTypeDef:
    return {
        "ConsumerDescription": ...,
        "ResponseMetadata": ...,
    }
# DescribeStreamConsumerOutputTypeDef definition

class DescribeStreamConsumerOutputTypeDef(TypedDict):
    ConsumerDescription: ConsumerDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConsumerDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListStreamConsumersOutputTypeDef#

# ListStreamConsumersOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import ListStreamConsumersOutputTypeDef

def get_value() -> ListStreamConsumersOutputTypeDef:
    return {
        "Consumers": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListStreamConsumersOutputTypeDef definition

class ListStreamConsumersOutputTypeDef(TypedDict):
    Consumers: List[ConsumerTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConsumerTypeDef
  2. See ResponseMetadataTypeDef

RegisterStreamConsumerOutputTypeDef#

# RegisterStreamConsumerOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import RegisterStreamConsumerOutputTypeDef

def get_value() -> RegisterStreamConsumerOutputTypeDef:
    return {
        "Consumer": ...,
        "ResponseMetadata": ...,
    }
# RegisterStreamConsumerOutputTypeDef definition

class RegisterStreamConsumerOutputTypeDef(TypedDict):
    Consumer: ConsumerTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConsumerTypeDef
  2. See ResponseMetadataTypeDef

CreateStreamInputRequestTypeDef#

# CreateStreamInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import CreateStreamInputRequestTypeDef

def get_value() -> CreateStreamInputRequestTypeDef:
    return {
        "StreamName": ...,
    }
# CreateStreamInputRequestTypeDef definition

class CreateStreamInputRequestTypeDef(TypedDict):
    StreamName: str,
    ShardCount: NotRequired[int],
    StreamModeDetails: NotRequired[StreamModeDetailsTypeDef],  # (1)
  1. See StreamModeDetailsTypeDef

StreamSummaryTypeDef#

# StreamSummaryTypeDef usage example

from mypy_boto3_kinesis.type_defs import StreamSummaryTypeDef

def get_value() -> StreamSummaryTypeDef:
    return {
        "StreamName": ...,
        "StreamARN": ...,
        "StreamStatus": ...,
    }
# StreamSummaryTypeDef definition

class StreamSummaryTypeDef(TypedDict):
    StreamName: str,
    StreamARN: str,
    StreamStatus: StreamStatusType,  # (1)
    StreamModeDetails: NotRequired[StreamModeDetailsTypeDef],  # (2)
    StreamCreationTimestamp: NotRequired[datetime],
  1. See StreamStatusType
  2. See StreamModeDetailsTypeDef

UpdateStreamModeInputRequestTypeDef#

# UpdateStreamModeInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import UpdateStreamModeInputRequestTypeDef

def get_value() -> UpdateStreamModeInputRequestTypeDef:
    return {
        "StreamARN": ...,
        "StreamModeDetails": ...,
    }
# UpdateStreamModeInputRequestTypeDef definition

class UpdateStreamModeInputRequestTypeDef(TypedDict):
    StreamARN: str,
    StreamModeDetails: StreamModeDetailsTypeDef,  # (1)
  1. See StreamModeDetailsTypeDef

DescribeStreamInputStreamExistsWaitTypeDef#

# DescribeStreamInputStreamExistsWaitTypeDef usage example

from mypy_boto3_kinesis.type_defs import DescribeStreamInputStreamExistsWaitTypeDef

def get_value() -> DescribeStreamInputStreamExistsWaitTypeDef:
    return {
        "StreamName": ...,
    }
# DescribeStreamInputStreamExistsWaitTypeDef definition

class DescribeStreamInputStreamExistsWaitTypeDef(TypedDict):
    StreamName: NotRequired[str],
    Limit: NotRequired[int],
    ExclusiveStartShardId: NotRequired[str],
    StreamARN: NotRequired[str],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeStreamInputStreamNotExistsWaitTypeDef#

# DescribeStreamInputStreamNotExistsWaitTypeDef usage example

from mypy_boto3_kinesis.type_defs import DescribeStreamInputStreamNotExistsWaitTypeDef

def get_value() -> DescribeStreamInputStreamNotExistsWaitTypeDef:
    return {
        "StreamName": ...,
    }
# DescribeStreamInputStreamNotExistsWaitTypeDef definition

class DescribeStreamInputStreamNotExistsWaitTypeDef(TypedDict):
    StreamName: NotRequired[str],
    Limit: NotRequired[int],
    ExclusiveStartShardId: NotRequired[str],
    StreamARN: NotRequired[str],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

StreamDescriptionSummaryTypeDef#

# StreamDescriptionSummaryTypeDef usage example

from mypy_boto3_kinesis.type_defs import StreamDescriptionSummaryTypeDef

def get_value() -> StreamDescriptionSummaryTypeDef:
    return {
        "StreamName": ...,
        "StreamARN": ...,
        "StreamStatus": ...,
        "RetentionPeriodHours": ...,
        "StreamCreationTimestamp": ...,
        "EnhancedMonitoring": ...,
        "OpenShardCount": ...,
    }
# StreamDescriptionSummaryTypeDef 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],
  1. See StreamStatusType
  2. See StreamModeDetailsTypeDef
  3. See EnhancedMetricsTypeDef
  4. See EncryptionTypeType

ListShardsInputListShardsPaginateTypeDef#

# ListShardsInputListShardsPaginateTypeDef usage example

from mypy_boto3_kinesis.type_defs import ListShardsInputListShardsPaginateTypeDef

def get_value() -> ListShardsInputListShardsPaginateTypeDef:
    return {
        "StreamName": ...,
    }
# ListShardsInputListShardsPaginateTypeDef 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)
  1. See ShardFilterTypeDef
  2. See PaginatorConfigTypeDef

ListShardsInputRequestTypeDef#

# ListShardsInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import ListShardsInputRequestTypeDef

def get_value() -> ListShardsInputRequestTypeDef:
    return {
        "StreamName": ...,
    }
# ListShardsInputRequestTypeDef 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],
  1. See ShardFilterTypeDef

ListTagsForStreamOutputTypeDef#

# ListTagsForStreamOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import ListTagsForStreamOutputTypeDef

def get_value() -> ListTagsForStreamOutputTypeDef:
    return {
        "Tags": ...,
        "HasMoreTags": ...,
        "ResponseMetadata": ...,
    }
# ListTagsForStreamOutputTypeDef definition

class ListTagsForStreamOutputTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    HasMoreTags: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

PutRecordsInputRequestTypeDef#

# PutRecordsInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import PutRecordsInputRequestTypeDef

def get_value() -> PutRecordsInputRequestTypeDef:
    return {
        "Records": ...,
    }
# PutRecordsInputRequestTypeDef definition

class PutRecordsInputRequestTypeDef(TypedDict):
    Records: Sequence[PutRecordsRequestEntryTypeDef],  # (1)
    StreamName: NotRequired[str],
    StreamARN: NotRequired[str],
  1. See PutRecordsRequestEntryTypeDef

PutRecordsOutputTypeDef#

# PutRecordsOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import PutRecordsOutputTypeDef

def get_value() -> PutRecordsOutputTypeDef:
    return {
        "FailedRecordCount": ...,
        "Records": ...,
        "EncryptionType": ...,
        "ResponseMetadata": ...,
    }
# PutRecordsOutputTypeDef definition

class PutRecordsOutputTypeDef(TypedDict):
    FailedRecordCount: int,
    Records: List[PutRecordsResultEntryTypeDef],  # (1)
    EncryptionType: EncryptionTypeType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PutRecordsResultEntryTypeDef
  2. See EncryptionTypeType
  3. See ResponseMetadataTypeDef

ShardTypeDef#

# ShardTypeDef usage example

from mypy_boto3_kinesis.type_defs import ShardTypeDef

def get_value() -> ShardTypeDef:
    return {
        "ShardId": ...,
        "HashKeyRange": ...,
        "SequenceNumberRange": ...,
    }
# ShardTypeDef definition

class ShardTypeDef(TypedDict):
    ShardId: str,
    HashKeyRange: HashKeyRangeTypeDef,  # (1)
    SequenceNumberRange: SequenceNumberRangeTypeDef,  # (2)
    ParentShardId: NotRequired[str],
    AdjacentParentShardId: NotRequired[str],
  1. See HashKeyRangeTypeDef
  2. See SequenceNumberRangeTypeDef

SubscribeToShardInputRequestTypeDef#

# SubscribeToShardInputRequestTypeDef usage example

from mypy_boto3_kinesis.type_defs import SubscribeToShardInputRequestTypeDef

def get_value() -> SubscribeToShardInputRequestTypeDef:
    return {
        "ConsumerARN": ...,
        "ShardId": ...,
        "StartingPosition": ...,
    }
# SubscribeToShardInputRequestTypeDef definition

class SubscribeToShardInputRequestTypeDef(TypedDict):
    ConsumerARN: str,
    ShardId: str,
    StartingPosition: StartingPositionTypeDef,  # (1)
  1. See StartingPositionTypeDef

GetRecordsOutputTypeDef#

# GetRecordsOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import GetRecordsOutputTypeDef

def get_value() -> GetRecordsOutputTypeDef:
    return {
        "Records": ...,
        "NextShardIterator": ...,
        "MillisBehindLatest": ...,
        "ChildShards": ...,
        "ResponseMetadata": ...,
    }
# GetRecordsOutputTypeDef definition

class GetRecordsOutputTypeDef(TypedDict):
    Records: List[RecordTypeDef],  # (1)
    NextShardIterator: str,
    MillisBehindLatest: int,
    ChildShards: List[ChildShardTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RecordTypeDef
  2. See ChildShardTypeDef
  3. See ResponseMetadataTypeDef

SubscribeToShardEventTypeDef#

# SubscribeToShardEventTypeDef usage example

from mypy_boto3_kinesis.type_defs import SubscribeToShardEventTypeDef

def get_value() -> SubscribeToShardEventTypeDef:
    return {
        "Records": ...,
        "ContinuationSequenceNumber": ...,
        "MillisBehindLatest": ...,
    }
# SubscribeToShardEventTypeDef definition

class SubscribeToShardEventTypeDef(TypedDict):
    Records: List[RecordTypeDef],  # (1)
    ContinuationSequenceNumber: str,
    MillisBehindLatest: int,
    ChildShards: NotRequired[List[ChildShardTypeDef]],  # (2)
  1. See RecordTypeDef
  2. See ChildShardTypeDef

ListStreamsOutputTypeDef#

# ListStreamsOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import ListStreamsOutputTypeDef

def get_value() -> ListStreamsOutputTypeDef:
    return {
        "StreamNames": ...,
        "HasMoreStreams": ...,
        "NextToken": ...,
        "StreamSummaries": ...,
        "ResponseMetadata": ...,
    }
# ListStreamsOutputTypeDef definition

class ListStreamsOutputTypeDef(TypedDict):
    StreamNames: List[str],
    HasMoreStreams: bool,
    NextToken: str,
    StreamSummaries: List[StreamSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StreamSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeStreamSummaryOutputTypeDef#

# DescribeStreamSummaryOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import DescribeStreamSummaryOutputTypeDef

def get_value() -> DescribeStreamSummaryOutputTypeDef:
    return {
        "StreamDescriptionSummary": ...,
        "ResponseMetadata": ...,
    }
# DescribeStreamSummaryOutputTypeDef definition

class DescribeStreamSummaryOutputTypeDef(TypedDict):
    StreamDescriptionSummary: StreamDescriptionSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StreamDescriptionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListShardsOutputTypeDef#

# ListShardsOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import ListShardsOutputTypeDef

def get_value() -> ListShardsOutputTypeDef:
    return {
        "Shards": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListShardsOutputTypeDef definition

class ListShardsOutputTypeDef(TypedDict):
    Shards: List[ShardTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ShardTypeDef
  2. See ResponseMetadataTypeDef

StreamDescriptionTypeDef#

# StreamDescriptionTypeDef usage example

from mypy_boto3_kinesis.type_defs import StreamDescriptionTypeDef

def get_value() -> StreamDescriptionTypeDef:
    return {
        "StreamName": ...,
        "StreamARN": ...,
        "StreamStatus": ...,
        "Shards": ...,
        "HasMoreShards": ...,
        "RetentionPeriodHours": ...,
        "StreamCreationTimestamp": ...,
        "EnhancedMonitoring": ...,
    }
# StreamDescriptionTypeDef 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],
  1. See StreamStatusType
  2. See StreamModeDetailsTypeDef
  3. See ShardTypeDef
  4. See EnhancedMetricsTypeDef
  5. See EncryptionTypeType

SubscribeToShardEventStreamTypeDef#

# SubscribeToShardEventStreamTypeDef usage example

from mypy_boto3_kinesis.type_defs import SubscribeToShardEventStreamTypeDef

def get_value() -> SubscribeToShardEventStreamTypeDef:
    return {
        "SubscribeToShardEvent": ...,
    }
# SubscribeToShardEventStreamTypeDef 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)
  1. See SubscribeToShardEventTypeDef
  2. See ResourceNotFoundExceptionTypeDef
  3. See ResourceInUseExceptionTypeDef
  4. See KMSDisabledExceptionTypeDef
  5. See KMSInvalidStateExceptionTypeDef
  6. See KMSAccessDeniedExceptionTypeDef
  7. See KMSNotFoundExceptionTypeDef
  8. See KMSOptInRequiredTypeDef
  9. See KMSThrottlingExceptionTypeDef
  10. See InternalFailureExceptionTypeDef

DescribeStreamOutputTypeDef#

# DescribeStreamOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import DescribeStreamOutputTypeDef

def get_value() -> DescribeStreamOutputTypeDef:
    return {
        "StreamDescription": ...,
        "ResponseMetadata": ...,
    }
# DescribeStreamOutputTypeDef definition

class DescribeStreamOutputTypeDef(TypedDict):
    StreamDescription: StreamDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StreamDescriptionTypeDef
  2. See ResponseMetadataTypeDef

SubscribeToShardOutputTypeDef#

# SubscribeToShardOutputTypeDef usage example

from mypy_boto3_kinesis.type_defs import SubscribeToShardOutputTypeDef

def get_value() -> SubscribeToShardOutputTypeDef:
    return {
        "EventStream": ...,
        "ResponseMetadata": ...,
    }
# SubscribeToShardOutputTypeDef definition

class SubscribeToShardOutputTypeDef(TypedDict):
    EventStream: SubscribeToShardEventStreamTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubscribeToShardEventStreamTypeDef
  2. See ResponseMetadataTypeDef