Type definitions

Index > KeyspacesStreams > Type definitions

Auto-generated documentation for KeyspacesStreams type annotations stubs module mypy-boto3-keyspacesstreams.

GetRecordsInputTypeDef

# GetRecordsInputTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import GetRecordsInputTypeDef


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


# GetRecordsInputTypeDef definition

class GetRecordsInputTypeDef(TypedDict):
    shardIterator: str,
    maxResults: NotRequired[int],

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.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],

GetShardIteratorInputTypeDef

# GetShardIteratorInputTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import GetShardIteratorInputTypeDef


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


# GetShardIteratorInputTypeDef definition

class GetShardIteratorInputTypeDef(TypedDict):
    streamArn: str,
    shardId: str,
    shardIteratorType: ShardIteratorTypeType,  # (1)
    sequenceNumber: NotRequired[str],

1. See ShardIteratorTypeType

PaginatorConfigTypeDef

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import PaginatorConfigTypeDef


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


# PaginatorConfigTypeDef definition

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

ShardFilterTypeDef

# ShardFilterTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import ShardFilterTypeDef


def get_value() -> ShardFilterTypeDef:
    return {
        "type": ...,
    }


# ShardFilterTypeDef definition

class ShardFilterTypeDef(TypedDict):
    type: NotRequired[ShardFilterTypeType],  # (1)
    shardId: NotRequired[str],

1. See ShardFilterTypeType

KeyspacesMetadataTypeDef

# KeyspacesMetadataTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import KeyspacesMetadataTypeDef


def get_value() -> KeyspacesMetadataTypeDef:
    return {
        "expirationTime": ...,
    }


# KeyspacesMetadataTypeDef definition

class KeyspacesMetadataTypeDef(TypedDict):
    expirationTime: NotRequired[str],
    writeTime: NotRequired[str],

ListStreamsInputTypeDef

# ListStreamsInputTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import ListStreamsInputTypeDef


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


# ListStreamsInputTypeDef definition

class ListStreamsInputTypeDef(TypedDict):
    keyspaceName: NotRequired[str],
    tableName: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

StreamTypeDef

# StreamTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import StreamTypeDef


def get_value() -> StreamTypeDef:
    return {
        "streamArn": ...,
    }


# StreamTypeDef definition

class StreamTypeDef(TypedDict):
    streamArn: str,
    keyspaceName: str,
    tableName: str,
    streamLabel: str,

SequenceNumberRangeTypeDef

# SequenceNumberRangeTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import SequenceNumberRangeTypeDef


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


# SequenceNumberRangeTypeDef definition

class SequenceNumberRangeTypeDef(TypedDict):
    startingSequenceNumber: NotRequired[str],
    endingSequenceNumber: NotRequired[str],

GetShardIteratorOutputTypeDef

# GetShardIteratorOutputTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import GetShardIteratorOutputTypeDef


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


# GetShardIteratorOutputTypeDef definition

class GetShardIteratorOutputTypeDef(TypedDict):
    shardIterator: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListStreamsInputPaginateTypeDef

# ListStreamsInputPaginateTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import ListStreamsInputPaginateTypeDef


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


# ListStreamsInputPaginateTypeDef definition

class ListStreamsInputPaginateTypeDef(TypedDict):
    keyspaceName: NotRequired[str],
    tableName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

GetStreamInputPaginateTypeDef

# GetStreamInputPaginateTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import GetStreamInputPaginateTypeDef


def get_value() -> GetStreamInputPaginateTypeDef:
    return {
        "streamArn": ...,
    }


# GetStreamInputPaginateTypeDef definition

class GetStreamInputPaginateTypeDef(TypedDict):
    streamArn: str,
    shardFilter: NotRequired[ShardFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

1. See ShardFilterTypeDef
2. See PaginatorConfigTypeDef

GetStreamInputTypeDef

# GetStreamInputTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import GetStreamInputTypeDef


def get_value() -> GetStreamInputTypeDef:
    return {
        "streamArn": ...,
    }


# GetStreamInputTypeDef definition

class GetStreamInputTypeDef(TypedDict):
    streamArn: str,
    maxResults: NotRequired[int],
    shardFilter: NotRequired[ShardFilterTypeDef],  # (1)
    nextToken: NotRequired[str],

1. See ShardFilterTypeDef

KeyspacesCellMapDefinitionTypeDef

# KeyspacesCellMapDefinitionTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import KeyspacesCellMapDefinitionTypeDef


def get_value() -> KeyspacesCellMapDefinitionTypeDef:
    return {
        "key": ...,
    }


# KeyspacesCellMapDefinitionTypeDef definition

class KeyspacesCellMapDefinitionTypeDef(TypedDict):
    key: NotRequired[Dict[str, Any]],
    value: NotRequired[Dict[str, Any]],
    metadata: NotRequired[KeyspacesMetadataTypeDef],  # (1)

1. See KeyspacesMetadataTypeDef

KeyspacesCellTypeDef

# KeyspacesCellTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import KeyspacesCellTypeDef


def get_value() -> KeyspacesCellTypeDef:
    return {
        "value": ...,
    }


# KeyspacesCellTypeDef definition

class KeyspacesCellTypeDef(TypedDict):
    value: NotRequired[Dict[str, Any]],
    metadata: NotRequired[KeyspacesMetadataTypeDef],  # (1)

1. See KeyspacesMetadataTypeDef

ListStreamsOutputTypeDef

# ListStreamsOutputTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import ListStreamsOutputTypeDef


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


# ListStreamsOutputTypeDef definition

class ListStreamsOutputTypeDef(TypedDict):
    streams: List[StreamTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

1. See List[StreamTypeDef]
2. See ResponseMetadataTypeDef

ShardTypeDef

# ShardTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import ShardTypeDef


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


# ShardTypeDef definition

class ShardTypeDef(TypedDict):
    shardId: NotRequired[str],
    sequenceNumberRange: NotRequired[SequenceNumberRangeTypeDef],  # (1)
    parentShardIds: NotRequired[List[str]],

1. See SequenceNumberRangeTypeDef

KeyspacesCellValueTypeDef

# KeyspacesCellValueTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import KeyspacesCellValueTypeDef


def get_value() -> KeyspacesCellValueTypeDef:
    return {
        "asciiT": ...,
    }


# KeyspacesCellValueTypeDef definition

class KeyspacesCellValueTypeDef(TypedDict):
    asciiT: NotRequired[str],
    bigintT: NotRequired[str],
    blobT: NotRequired[bytes],
    boolT: NotRequired[bool],
    counterT: NotRequired[str],
    dateT: NotRequired[str],
    decimalT: NotRequired[str],
    doubleT: NotRequired[str],
    floatT: NotRequired[str],
    inetT: NotRequired[str],
    intT: NotRequired[str],
    listT: NotRequired[List[KeyspacesCellTypeDef]],  # (1)
    mapT: NotRequired[List[KeyspacesCellMapDefinitionTypeDef]],  # (2)
    setT: NotRequired[List[KeyspacesCellTypeDef]],  # (1)
    smallintT: NotRequired[str],
    textT: NotRequired[str],
    timeT: NotRequired[str],
    timestampT: NotRequired[str],
    timeuuidT: NotRequired[str],
    tinyintT: NotRequired[str],
    tupleT: NotRequired[List[KeyspacesCellTypeDef]],  # (1)
    uuidT: NotRequired[str],
    varcharT: NotRequired[str],
    varintT: NotRequired[str],
    udtT: NotRequired[Dict[str, KeyspacesCellTypeDef]],  # (5)

1. See List[KeyspacesCellTypeDef]
2. See List[KeyspacesCellMapDefinitionTypeDef]
3. See List[KeyspacesCellTypeDef]
4. See List[KeyspacesCellTypeDef]
5. See Dict[str, KeyspacesCellTypeDef]

KeyspacesRowTypeDef

# KeyspacesRowTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import KeyspacesRowTypeDef


def get_value() -> KeyspacesRowTypeDef:
    return {
        "valueCells": ...,
    }


# KeyspacesRowTypeDef definition

class KeyspacesRowTypeDef(TypedDict):
    valueCells: NotRequired[Dict[str, KeyspacesCellTypeDef]],  # (1)
    staticCells: NotRequired[Dict[str, KeyspacesCellTypeDef]],  # (1)
    rowMetadata: NotRequired[KeyspacesMetadataTypeDef],  # (3)

1. See Dict[str, KeyspacesCellTypeDef]
2. See Dict[str, KeyspacesCellTypeDef]
3. See KeyspacesMetadataTypeDef

GetStreamOutputTypeDef

# GetStreamOutputTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import GetStreamOutputTypeDef


def get_value() -> GetStreamOutputTypeDef:
    return {
        "streamArn": ...,
    }


# GetStreamOutputTypeDef definition

class GetStreamOutputTypeDef(TypedDict):
    streamArn: str,
    streamLabel: str,
    streamStatus: StreamStatusType,  # (1)
    streamViewType: StreamViewTypeType,  # (2)
    creationRequestDateTime: datetime.datetime,
    keyspaceName: str,
    tableName: str,
    shards: List[ShardTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
    nextToken: NotRequired[str],

1. See StreamStatusType
2. See StreamViewTypeType
3. See List[ShardTypeDef]
4. See ResponseMetadataTypeDef

RecordTypeDef

# RecordTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import RecordTypeDef


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


# RecordTypeDef definition

class RecordTypeDef(TypedDict):
    eventVersion: NotRequired[str],
    createdAt: NotRequired[datetime.datetime],
    origin: NotRequired[OriginTypeType],  # (1)
    partitionKeys: NotRequired[Dict[str, KeyspacesCellValueTypeDef]],  # (2)
    clusteringKeys: NotRequired[Dict[str, KeyspacesCellValueTypeDef]],  # (2)
    newImage: NotRequired[KeyspacesRowTypeDef],  # (4)
    oldImage: NotRequired[KeyspacesRowTypeDef],  # (4)
    sequenceNumber: NotRequired[str],

1. See OriginTypeType
2. See Dict[str, KeyspacesCellValueTypeDef]
3. See Dict[str, KeyspacesCellValueTypeDef]
4. See KeyspacesRowTypeDef
5. See KeyspacesRowTypeDef

GetRecordsOutputTypeDef

# GetRecordsOutputTypeDef TypedDict usage example

from mypy_boto3_keyspacesstreams.type_defs import GetRecordsOutputTypeDef


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


# GetRecordsOutputTypeDef definition

class GetRecordsOutputTypeDef(TypedDict):
    changeRecords: List[RecordTypeDef],  # (1)
    nextShardIterator: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[RecordTypeDef]
2. See ResponseMetadataTypeDef