Skip to content

Type definitions#

Index > Kinesis > Type definitions

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

BlobTypeDef#

# BlobTypeDef Union usage example

from types_boto3_kinesis.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef Union usage example

from types_boto3_kinesis.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

AddTagsToStreamInputTypeDef#

# AddTagsToStreamInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import AddTagsToStreamInputTypeDef


def get_value() -> AddTagsToStreamInputTypeDef:
    return {
        "Tags": ...,
    }


# AddTagsToStreamInputTypeDef definition

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

HashKeyRangeTypeDef#

# HashKeyRangeTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import HashKeyRangeTypeDef


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


# HashKeyRangeTypeDef definition

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

ConsumerDescriptionTypeDef#

# ConsumerDescriptionTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ConsumerDescriptionTypeDef


def get_value() -> ConsumerDescriptionTypeDef:
    return {
        "ConsumerName": ...,
    }


# ConsumerDescriptionTypeDef definition

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

ConsumerTypeDef#

# ConsumerTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ConsumerTypeDef


def get_value() -> ConsumerTypeDef:
    return {
        "ConsumerName": ...,
    }


# ConsumerTypeDef definition

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

StreamModeDetailsTypeDef#

# StreamModeDetailsTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import StreamModeDetailsTypeDef


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


# StreamModeDetailsTypeDef definition

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

DecreaseStreamRetentionPeriodInputTypeDef#

# DecreaseStreamRetentionPeriodInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DecreaseStreamRetentionPeriodInputTypeDef


def get_value() -> DecreaseStreamRetentionPeriodInputTypeDef:
    return {
        "RetentionPeriodHours": ...,
    }


# DecreaseStreamRetentionPeriodInputTypeDef definition

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

DeleteResourcePolicyInputTypeDef#

# DeleteResourcePolicyInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DeleteResourcePolicyInputTypeDef


def get_value() -> DeleteResourcePolicyInputTypeDef:
    return {
        "ResourceARN": ...,
    }


# DeleteResourcePolicyInputTypeDef definition

class DeleteResourcePolicyInputTypeDef(TypedDict):
    ResourceARN: str,

DeleteStreamInputTypeDef#

# DeleteStreamInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DeleteStreamInputTypeDef


def get_value() -> DeleteStreamInputTypeDef:
    return {
        "StreamName": ...,
    }


# DeleteStreamInputTypeDef definition

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

DeregisterStreamConsumerInputTypeDef#

# DeregisterStreamConsumerInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DeregisterStreamConsumerInputTypeDef


def get_value() -> DeregisterStreamConsumerInputTypeDef:
    return {
        "StreamARN": ...,
    }


# DeregisterStreamConsumerInputTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

DescribeStreamConsumerInputTypeDef#

# DescribeStreamConsumerInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DescribeStreamConsumerInputTypeDef


def get_value() -> DescribeStreamConsumerInputTypeDef:
    return {
        "StreamARN": ...,
    }


# DescribeStreamConsumerInputTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_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],

DescribeStreamInputTypeDef#

# DescribeStreamInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DescribeStreamInputTypeDef


def get_value() -> DescribeStreamInputTypeDef:
    return {
        "StreamName": ...,
    }


# DescribeStreamInputTypeDef definition

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

WaiterConfigTypeDef#

# WaiterConfigTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import WaiterConfigTypeDef


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


# WaiterConfigTypeDef definition

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

DescribeStreamSummaryInputTypeDef#

# DescribeStreamSummaryInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DescribeStreamSummaryInputTypeDef


def get_value() -> DescribeStreamSummaryInputTypeDef:
    return {
        "StreamName": ...,
    }


# DescribeStreamSummaryInputTypeDef definition

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

DisableEnhancedMonitoringInputTypeDef#

# DisableEnhancedMonitoringInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DisableEnhancedMonitoringInputTypeDef


def get_value() -> DisableEnhancedMonitoringInputTypeDef:
    return {
        "ShardLevelMetrics": ...,
    }


# DisableEnhancedMonitoringInputTypeDef definition

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

EnableEnhancedMonitoringInputTypeDef#

# EnableEnhancedMonitoringInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import EnableEnhancedMonitoringInputTypeDef


def get_value() -> EnableEnhancedMonitoringInputTypeDef:
    return {
        "ShardLevelMetrics": ...,
    }


# EnableEnhancedMonitoringInputTypeDef definition

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

EnhancedMetricsTypeDef#

# EnhancedMetricsTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import EnhancedMetricsTypeDef


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


# EnhancedMetricsTypeDef definition

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

GetRecordsInputTypeDef#

# GetRecordsInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import GetRecordsInputTypeDef


def get_value() -> GetRecordsInputTypeDef:
    return {
        "ShardIterator": ...,
    }


# GetRecordsInputTypeDef definition

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

RecordTypeDef#

# RecordTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import RecordTypeDef


def get_value() -> RecordTypeDef:
    return {
        "SequenceNumber": ...,
    }


# RecordTypeDef definition

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

GetResourcePolicyInputTypeDef#

# GetResourcePolicyInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import GetResourcePolicyInputTypeDef


def get_value() -> GetResourcePolicyInputTypeDef:
    return {
        "ResourceARN": ...,
    }


# GetResourcePolicyInputTypeDef definition

class GetResourcePolicyInputTypeDef(TypedDict):
    ResourceARN: str,

IncreaseStreamRetentionPeriodInputTypeDef#

# IncreaseStreamRetentionPeriodInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import IncreaseStreamRetentionPeriodInputTypeDef


def get_value() -> IncreaseStreamRetentionPeriodInputTypeDef:
    return {
        "RetentionPeriodHours": ...,
    }


# IncreaseStreamRetentionPeriodInputTypeDef definition

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

InternalFailureExceptionTypeDef#

# InternalFailureExceptionTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import InternalFailureExceptionTypeDef


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


# InternalFailureExceptionTypeDef definition

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

KMSAccessDeniedExceptionTypeDef#

# KMSAccessDeniedExceptionTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import KMSAccessDeniedExceptionTypeDef


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


# KMSAccessDeniedExceptionTypeDef definition

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

KMSDisabledExceptionTypeDef#

# KMSDisabledExceptionTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import KMSDisabledExceptionTypeDef


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


# KMSDisabledExceptionTypeDef definition

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

KMSInvalidStateExceptionTypeDef#

# KMSInvalidStateExceptionTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import KMSInvalidStateExceptionTypeDef


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


# KMSInvalidStateExceptionTypeDef definition

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

KMSNotFoundExceptionTypeDef#

# KMSNotFoundExceptionTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import KMSNotFoundExceptionTypeDef


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


# KMSNotFoundExceptionTypeDef definition

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

KMSOptInRequiredTypeDef#

# KMSOptInRequiredTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import KMSOptInRequiredTypeDef


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


# KMSOptInRequiredTypeDef definition

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

KMSThrottlingExceptionTypeDef#

# KMSThrottlingExceptionTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import KMSThrottlingExceptionTypeDef


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


# KMSThrottlingExceptionTypeDef definition

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

ListStreamsInputTypeDef#

# ListStreamsInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListStreamsInputTypeDef


def get_value() -> ListStreamsInputTypeDef:
    return {
        "Limit": ...,
    }


# ListStreamsInputTypeDef definition

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

ListTagsForResourceInputTypeDef#

# ListTagsForResourceInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListTagsForResourceInputTypeDef


def get_value() -> ListTagsForResourceInputTypeDef:
    return {
        "ResourceARN": ...,
    }


# ListTagsForResourceInputTypeDef definition

class ListTagsForResourceInputTypeDef(TypedDict):
    ResourceARN: str,

TagTypeDef#

# TagTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import TagTypeDef


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


# TagTypeDef definition

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

ListTagsForStreamInputTypeDef#

# ListTagsForStreamInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListTagsForStreamInputTypeDef


def get_value() -> ListTagsForStreamInputTypeDef:
    return {
        "StreamName": ...,
    }


# ListTagsForStreamInputTypeDef definition

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

MergeShardsInputTypeDef#

# MergeShardsInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import MergeShardsInputTypeDef


def get_value() -> MergeShardsInputTypeDef:
    return {
        "ShardToMerge": ...,
    }


# MergeShardsInputTypeDef definition

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

PutRecordsResultEntryTypeDef#

# PutRecordsResultEntryTypeDef TypedDict usage example

from types_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],

PutResourcePolicyInputTypeDef#

# PutResourcePolicyInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import PutResourcePolicyInputTypeDef


def get_value() -> PutResourcePolicyInputTypeDef:
    return {
        "ResourceARN": ...,
    }


# PutResourcePolicyInputTypeDef definition

class PutResourcePolicyInputTypeDef(TypedDict):
    ResourceARN: str,
    Policy: str,

RegisterStreamConsumerInputTypeDef#

# RegisterStreamConsumerInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import RegisterStreamConsumerInputTypeDef


def get_value() -> RegisterStreamConsumerInputTypeDef:
    return {
        "StreamARN": ...,
    }


# RegisterStreamConsumerInputTypeDef definition

class RegisterStreamConsumerInputTypeDef(TypedDict):
    StreamARN: str,
    ConsumerName: str,
    Tags: NotRequired[Mapping[str, str]],

RemoveTagsFromStreamInputTypeDef#

# RemoveTagsFromStreamInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import RemoveTagsFromStreamInputTypeDef


def get_value() -> RemoveTagsFromStreamInputTypeDef:
    return {
        "TagKeys": ...,
    }


# RemoveTagsFromStreamInputTypeDef definition

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

ResourceInUseExceptionTypeDef#

# ResourceInUseExceptionTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ResourceInUseExceptionTypeDef


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


# ResourceInUseExceptionTypeDef definition

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

ResourceNotFoundExceptionTypeDef#

# ResourceNotFoundExceptionTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ResourceNotFoundExceptionTypeDef


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


# ResourceNotFoundExceptionTypeDef definition

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

SequenceNumberRangeTypeDef#

# SequenceNumberRangeTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import SequenceNumberRangeTypeDef


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


# SequenceNumberRangeTypeDef definition

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

SplitShardInputTypeDef#

# SplitShardInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import SplitShardInputTypeDef


def get_value() -> SplitShardInputTypeDef:
    return {
        "ShardToSplit": ...,
    }


# SplitShardInputTypeDef definition

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

StartStreamEncryptionInputTypeDef#

# StartStreamEncryptionInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import StartStreamEncryptionInputTypeDef


def get_value() -> StartStreamEncryptionInputTypeDef:
    return {
        "EncryptionType": ...,
    }


# StartStreamEncryptionInputTypeDef definition

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

StopStreamEncryptionInputTypeDef#

# StopStreamEncryptionInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import StopStreamEncryptionInputTypeDef


def get_value() -> StopStreamEncryptionInputTypeDef:
    return {
        "EncryptionType": ...,
    }


# StopStreamEncryptionInputTypeDef definition

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

TagResourceInputTypeDef#

# TagResourceInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import TagResourceInputTypeDef


def get_value() -> TagResourceInputTypeDef:
    return {
        "Tags": ...,
    }


# TagResourceInputTypeDef definition

class TagResourceInputTypeDef(TypedDict):
    Tags: Mapping[str, str],
    ResourceARN: str,

UntagResourceInputTypeDef#

# UntagResourceInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import UntagResourceInputTypeDef


def get_value() -> UntagResourceInputTypeDef:
    return {
        "TagKeys": ...,
    }


# UntagResourceInputTypeDef definition

class UntagResourceInputTypeDef(TypedDict):
    TagKeys: Sequence[str],
    ResourceARN: str,

UpdateMaxRecordSizeInputTypeDef#

# UpdateMaxRecordSizeInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import UpdateMaxRecordSizeInputTypeDef


def get_value() -> UpdateMaxRecordSizeInputTypeDef:
    return {
        "MaxRecordSizeInKiB": ...,
    }


# UpdateMaxRecordSizeInputTypeDef definition

class UpdateMaxRecordSizeInputTypeDef(TypedDict):
    MaxRecordSizeInKiB: int,
    StreamARN: NotRequired[str],

UpdateShardCountInputTypeDef#

# UpdateShardCountInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import UpdateShardCountInputTypeDef


def get_value() -> UpdateShardCountInputTypeDef:
    return {
        "TargetShardCount": ...,
    }


# UpdateShardCountInputTypeDef definition

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

PutRecordInputTypeDef#

# PutRecordInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import PutRecordInputTypeDef


def get_value() -> PutRecordInputTypeDef:
    return {
        "Data": ...,
    }


# PutRecordInputTypeDef definition

class PutRecordInputTypeDef(TypedDict):
    Data: BlobTypeDef,
    PartitionKey: str,
    StreamName: NotRequired[str],
    ExplicitHashKey: NotRequired[str],
    SequenceNumberForOrdering: NotRequired[str],
    StreamARN: NotRequired[str],

PutRecordsRequestEntryTypeDef#

# PutRecordsRequestEntryTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import PutRecordsRequestEntryTypeDef


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


# PutRecordsRequestEntryTypeDef definition

class PutRecordsRequestEntryTypeDef(TypedDict):
    Data: BlobTypeDef,
    PartitionKey: str,
    ExplicitHashKey: NotRequired[str],

ChildShardTypeDef#

# ChildShardTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ChildShardTypeDef


def get_value() -> ChildShardTypeDef:
    return {
        "ShardId": ...,
    }


# ChildShardTypeDef definition

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

CreateStreamInputTypeDef#

# CreateStreamInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import CreateStreamInputTypeDef


def get_value() -> CreateStreamInputTypeDef:
    return {
        "StreamName": ...,
    }


# CreateStreamInputTypeDef definition

class CreateStreamInputTypeDef(TypedDict):
    StreamName: str,
    ShardCount: NotRequired[int],
    StreamModeDetails: NotRequired[StreamModeDetailsTypeDef],  # (1)
    Tags: NotRequired[Mapping[str, str]],
    MaxRecordSizeInKiB: NotRequired[int],
  1. See StreamModeDetailsTypeDef

StreamSummaryTypeDef#

# StreamSummaryTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import StreamSummaryTypeDef


def get_value() -> StreamSummaryTypeDef:
    return {
        "StreamName": ...,
    }


# StreamSummaryTypeDef definition

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

UpdateStreamModeInputTypeDef#

# UpdateStreamModeInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import UpdateStreamModeInputTypeDef


def get_value() -> UpdateStreamModeInputTypeDef:
    return {
        "StreamARN": ...,
    }


# UpdateStreamModeInputTypeDef definition

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

DescribeLimitsOutputTypeDef#

# DescribeLimitsOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DescribeLimitsOutputTypeDef


def get_value() -> DescribeLimitsOutputTypeDef:
    return {
        "ShardLimit": ...,
    }


# DescribeLimitsOutputTypeDef definition

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

DescribeStreamConsumerOutputTypeDef#

# DescribeStreamConsumerOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DescribeStreamConsumerOutputTypeDef


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


# DescribeStreamConsumerOutputTypeDef definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import EmptyResponseMetadataTypeDef


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


# EmptyResponseMetadataTypeDef definition

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

EnhancedMonitoringOutputTypeDef#

# EnhancedMonitoringOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import EnhancedMonitoringOutputTypeDef


def get_value() -> EnhancedMonitoringOutputTypeDef:
    return {
        "StreamName": ...,
    }


# EnhancedMonitoringOutputTypeDef definition

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

GetResourcePolicyOutputTypeDef#

# GetResourcePolicyOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import GetResourcePolicyOutputTypeDef


def get_value() -> GetResourcePolicyOutputTypeDef:
    return {
        "Policy": ...,
    }


# GetResourcePolicyOutputTypeDef definition

class GetResourcePolicyOutputTypeDef(TypedDict):
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetShardIteratorOutputTypeDef#

# GetShardIteratorOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import GetShardIteratorOutputTypeDef


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


# GetShardIteratorOutputTypeDef definition

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

ListStreamConsumersOutputTypeDef#

# ListStreamConsumersOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListStreamConsumersOutputTypeDef


def get_value() -> ListStreamConsumersOutputTypeDef:
    return {
        "Consumers": ...,
    }


# ListStreamConsumersOutputTypeDef definition

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

PutRecordOutputTypeDef#

# PutRecordOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import PutRecordOutputTypeDef


def get_value() -> PutRecordOutputTypeDef:
    return {
        "ShardId": ...,
    }


# PutRecordOutputTypeDef definition

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

RegisterStreamConsumerOutputTypeDef#

# RegisterStreamConsumerOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import RegisterStreamConsumerOutputTypeDef


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


# RegisterStreamConsumerOutputTypeDef definition

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

UpdateShardCountOutputTypeDef#

# UpdateShardCountOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import UpdateShardCountOutputTypeDef


def get_value() -> UpdateShardCountOutputTypeDef:
    return {
        "StreamName": ...,
    }


# UpdateShardCountOutputTypeDef definition

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

DescribeStreamInputPaginateTypeDef#

# DescribeStreamInputPaginateTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DescribeStreamInputPaginateTypeDef


def get_value() -> DescribeStreamInputPaginateTypeDef:
    return {
        "StreamName": ...,
    }


# DescribeStreamInputPaginateTypeDef definition

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

ListStreamsInputPaginateTypeDef#

# ListStreamsInputPaginateTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListStreamsInputPaginateTypeDef


def get_value() -> ListStreamsInputPaginateTypeDef:
    return {
        "ExclusiveStartStreamName": ...,
    }


# ListStreamsInputPaginateTypeDef definition

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

DescribeStreamInputWaitExtraTypeDef#

# DescribeStreamInputWaitExtraTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DescribeStreamInputWaitExtraTypeDef


def get_value() -> DescribeStreamInputWaitExtraTypeDef:
    return {
        "StreamName": ...,
    }


# DescribeStreamInputWaitExtraTypeDef definition

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

DescribeStreamInputWaitTypeDef#

# DescribeStreamInputWaitTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DescribeStreamInputWaitTypeDef


def get_value() -> DescribeStreamInputWaitTypeDef:
    return {
        "StreamName": ...,
    }


# DescribeStreamInputWaitTypeDef definition

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

StreamDescriptionSummaryTypeDef#

# StreamDescriptionSummaryTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import StreamDescriptionSummaryTypeDef


def get_value() -> StreamDescriptionSummaryTypeDef:
    return {
        "StreamName": ...,
    }


# StreamDescriptionSummaryTypeDef definition

class StreamDescriptionSummaryTypeDef(TypedDict):
    StreamName: str,
    StreamARN: str,
    StreamStatus: StreamStatusType,  # (1)
    RetentionPeriodHours: int,
    StreamCreationTimestamp: datetime.datetime,
    EnhancedMonitoring: List[EnhancedMetricsTypeDef],  # (3)
    OpenShardCount: int,
    StreamModeDetails: NotRequired[StreamModeDetailsTypeDef],  # (2)
    EncryptionType: NotRequired[EncryptionTypeType],  # (4)
    KeyId: NotRequired[str],
    ConsumerCount: NotRequired[int],
    MaxRecordSizeInKiB: NotRequired[int],
  1. See StreamStatusType
  2. See StreamModeDetailsTypeDef
  3. See List[EnhancedMetricsTypeDef]
  4. See EncryptionTypeType

GetShardIteratorInputTypeDef#

# GetShardIteratorInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import GetShardIteratorInputTypeDef


def get_value() -> GetShardIteratorInputTypeDef:
    return {
        "ShardId": ...,
    }


# GetShardIteratorInputTypeDef definition

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

ListStreamConsumersInputPaginateTypeDef#

# ListStreamConsumersInputPaginateTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListStreamConsumersInputPaginateTypeDef


def get_value() -> ListStreamConsumersInputPaginateTypeDef:
    return {
        "StreamARN": ...,
    }


# ListStreamConsumersInputPaginateTypeDef definition

class ListStreamConsumersInputPaginateTypeDef(TypedDict):
    StreamARN: str,
    StreamCreationTimestamp: NotRequired[TimestampTypeDef],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListStreamConsumersInputTypeDef#

# ListStreamConsumersInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListStreamConsumersInputTypeDef


def get_value() -> ListStreamConsumersInputTypeDef:
    return {
        "StreamARN": ...,
    }


# ListStreamConsumersInputTypeDef definition

class ListStreamConsumersInputTypeDef(TypedDict):
    StreamARN: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    StreamCreationTimestamp: NotRequired[TimestampTypeDef],

ShardFilterTypeDef#

# ShardFilterTypeDef TypedDict usage example

from types_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[TimestampTypeDef],
  1. See ShardFilterTypeType

StartingPositionTypeDef#

# StartingPositionTypeDef TypedDict usage example

from types_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[TimestampTypeDef],
  1. See ShardIteratorTypeType

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListTagsForResourceOutputTypeDef


def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "Tags": ...,
    }


# ListTagsForResourceOutputTypeDef definition

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

ListTagsForStreamOutputTypeDef#

# ListTagsForStreamOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListTagsForStreamOutputTypeDef


def get_value() -> ListTagsForStreamOutputTypeDef:
    return {
        "Tags": ...,
    }


# ListTagsForStreamOutputTypeDef definition

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

PutRecordsOutputTypeDef#

# PutRecordsOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import PutRecordsOutputTypeDef


def get_value() -> PutRecordsOutputTypeDef:
    return {
        "FailedRecordCount": ...,
    }


# PutRecordsOutputTypeDef definition

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

ShardTypeDef#

# ShardTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ShardTypeDef


def get_value() -> ShardTypeDef:
    return {
        "ShardId": ...,
    }


# 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

PutRecordsInputTypeDef#

# PutRecordsInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import PutRecordsInputTypeDef


def get_value() -> PutRecordsInputTypeDef:
    return {
        "Records": ...,
    }


# PutRecordsInputTypeDef definition

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

GetRecordsOutputTypeDef#

# GetRecordsOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import GetRecordsOutputTypeDef


def get_value() -> GetRecordsOutputTypeDef:
    return {
        "Records": ...,
    }


# GetRecordsOutputTypeDef definition

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

SubscribeToShardEventTypeDef#

# SubscribeToShardEventTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import SubscribeToShardEventTypeDef


def get_value() -> SubscribeToShardEventTypeDef:
    return {
        "Records": ...,
    }


# SubscribeToShardEventTypeDef definition

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

ListStreamsOutputTypeDef#

# ListStreamsOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListStreamsOutputTypeDef


def get_value() -> ListStreamsOutputTypeDef:
    return {
        "StreamNames": ...,
    }


# ListStreamsOutputTypeDef definition

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

DescribeStreamSummaryOutputTypeDef#

# DescribeStreamSummaryOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import DescribeStreamSummaryOutputTypeDef


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


# DescribeStreamSummaryOutputTypeDef definition

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

ListShardsInputPaginateTypeDef#

# ListShardsInputPaginateTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListShardsInputPaginateTypeDef


def get_value() -> ListShardsInputPaginateTypeDef:
    return {
        "StreamName": ...,
    }


# ListShardsInputPaginateTypeDef definition

class ListShardsInputPaginateTypeDef(TypedDict):
    StreamName: NotRequired[str],
    ExclusiveStartShardId: NotRequired[str],
    StreamCreationTimestamp: NotRequired[TimestampTypeDef],
    ShardFilter: NotRequired[ShardFilterTypeDef],  # (1)
    StreamARN: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ShardFilterTypeDef
  2. See PaginatorConfigTypeDef

ListShardsInputTypeDef#

# ListShardsInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListShardsInputTypeDef


def get_value() -> ListShardsInputTypeDef:
    return {
        "StreamName": ...,
    }


# ListShardsInputTypeDef definition

class ListShardsInputTypeDef(TypedDict):
    StreamName: NotRequired[str],
    NextToken: NotRequired[str],
    ExclusiveStartShardId: NotRequired[str],
    MaxResults: NotRequired[int],
    StreamCreationTimestamp: NotRequired[TimestampTypeDef],
    ShardFilter: NotRequired[ShardFilterTypeDef],  # (1)
    StreamARN: NotRequired[str],
  1. See ShardFilterTypeDef

SubscribeToShardInputTypeDef#

# SubscribeToShardInputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import SubscribeToShardInputTypeDef


def get_value() -> SubscribeToShardInputTypeDef:
    return {
        "ConsumerARN": ...,
    }


# SubscribeToShardInputTypeDef definition

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

ListShardsOutputTypeDef#

# ListShardsOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import ListShardsOutputTypeDef


def get_value() -> ListShardsOutputTypeDef:
    return {
        "Shards": ...,
    }


# ListShardsOutputTypeDef definition

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

StreamDescriptionTypeDef#

# StreamDescriptionTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import StreamDescriptionTypeDef


def get_value() -> StreamDescriptionTypeDef:
    return {
        "StreamName": ...,
    }


# StreamDescriptionTypeDef definition

class StreamDescriptionTypeDef(TypedDict):
    StreamName: str,
    StreamARN: str,
    StreamStatus: StreamStatusType,  # (1)
    Shards: List[ShardTypeDef],  # (3)
    HasMoreShards: bool,
    RetentionPeriodHours: int,
    StreamCreationTimestamp: datetime.datetime,
    EnhancedMonitoring: List[EnhancedMetricsTypeDef],  # (4)
    StreamModeDetails: NotRequired[StreamModeDetailsTypeDef],  # (2)
    EncryptionType: NotRequired[EncryptionTypeType],  # (5)
    KeyId: NotRequired[str],
  1. See StreamStatusType
  2. See StreamModeDetailsTypeDef
  3. See List[ShardTypeDef]
  4. See List[EnhancedMetricsTypeDef]
  5. See EncryptionTypeType

SubscribeToShardEventStreamTypeDef#

# SubscribeToShardEventStreamTypeDef TypedDict usage example

from types_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 TypedDict usage example

from types_boto3_kinesis.type_defs import DescribeStreamOutputTypeDef


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


# DescribeStreamOutputTypeDef definition

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

SubscribeToShardOutputTypeDef#

# SubscribeToShardOutputTypeDef TypedDict usage example

from types_boto3_kinesis.type_defs import SubscribeToShardOutputTypeDef


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


# SubscribeToShardOutputTypeDef definition

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