Skip to content

Type definitions#

Index > Kinesis > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AddTagsToStreamInputRequestTypeDef#

# AddTagsToStreamInputRequestTypeDef definition

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

HashKeyRangeTypeDef#

# HashKeyRangeTypeDef definition

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

ConsumerDescriptionTypeDef#

# ConsumerDescriptionTypeDef definition

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

ConsumerTypeDef#

# ConsumerTypeDef definition

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

StreamModeDetailsTypeDef#

# StreamModeDetailsTypeDef definition

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

DecreaseStreamRetentionPeriodInputRequestTypeDef#

# DecreaseStreamRetentionPeriodInputRequestTypeDef definition

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

DeleteResourcePolicyInputRequestTypeDef#

# DeleteResourcePolicyInputRequestTypeDef definition

class DeleteResourcePolicyInputRequestTypeDef(TypedDict):
    ResourceARN: str,

DeleteStreamInputRequestTypeDef#

# DeleteStreamInputRequestTypeDef definition

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

DeregisterStreamConsumerInputRequestTypeDef#

# DeregisterStreamConsumerInputRequestTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DescribeStreamConsumerInputRequestTypeDef#

# DescribeStreamConsumerInputRequestTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeStreamInputRequestTypeDef#

# DescribeStreamInputRequestTypeDef definition

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

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

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

DescribeStreamSummaryInputRequestTypeDef#

# DescribeStreamSummaryInputRequestTypeDef definition

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

DisableEnhancedMonitoringInputRequestTypeDef#

# DisableEnhancedMonitoringInputRequestTypeDef definition

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

EnableEnhancedMonitoringInputRequestTypeDef#

# EnableEnhancedMonitoringInputRequestTypeDef definition

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

EnhancedMetricsTypeDef#

# EnhancedMetricsTypeDef definition

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

GetRecordsInputRequestTypeDef#

# GetRecordsInputRequestTypeDef definition

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

RecordTypeDef#

# RecordTypeDef definition

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

GetResourcePolicyInputRequestTypeDef#

# GetResourcePolicyInputRequestTypeDef definition

class GetResourcePolicyInputRequestTypeDef(TypedDict):
    ResourceARN: str,

IncreaseStreamRetentionPeriodInputRequestTypeDef#

# IncreaseStreamRetentionPeriodInputRequestTypeDef definition

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

InternalFailureExceptionTypeDef#

# InternalFailureExceptionTypeDef definition

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

KMSAccessDeniedExceptionTypeDef#

# KMSAccessDeniedExceptionTypeDef definition

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

KMSDisabledExceptionTypeDef#

# KMSDisabledExceptionTypeDef definition

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

KMSInvalidStateExceptionTypeDef#

# KMSInvalidStateExceptionTypeDef definition

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

KMSNotFoundExceptionTypeDef#

# KMSNotFoundExceptionTypeDef definition

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

KMSOptInRequiredTypeDef#

#