Skip to content

Type definitions#

Index > DynamoDBStreams > Type definitions

Auto-generated documentation for DynamoDBStreams type annotations stubs module types-boto3-dynamodbstreams.

AttributeValueTypeDef#

# AttributeValueTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import AttributeValueTypeDef


def get_value() -> AttributeValueTypeDef:
    return {
        "S": ...,
    }


# AttributeValueTypeDef definition

class AttributeValueTypeDef(TypedDict):
    S: NotRequired[str],
    N: NotRequired[str],
    B: NotRequired[bytes],
    SS: NotRequired[List[str]],
    NS: NotRequired[List[str]],
    BS: NotRequired[List[bytes]],
    M: NotRequired[Dict[str, Dict[str, Any]]],
    L: NotRequired[List[Dict[str, Any]]],
    NULL: NotRequired[bool],
    BOOL: NotRequired[bool],

ShardFilterTypeDef#

# ShardFilterTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

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

GetRecordsInputTypeDef#

# GetRecordsInputTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import GetRecordsInputTypeDef


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


# GetRecordsInputTypeDef definition

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

GetShardIteratorInputTypeDef#

# GetShardIteratorInputTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.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

IdentityTypeDef#

# IdentityTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import IdentityTypeDef


def get_value() -> IdentityTypeDef:
    return {
        "PrincipalId": ...,
    }


# IdentityTypeDef definition

class IdentityTypeDef(TypedDict):
    PrincipalId: NotRequired[str],
    Type: NotRequired[str],

KeySchemaElementTypeDef#

# KeySchemaElementTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import KeySchemaElementTypeDef


def get_value() -> KeySchemaElementTypeDef:
    return {
        "AttributeName": ...,
    }


# KeySchemaElementTypeDef definition

class KeySchemaElementTypeDef(TypedDict):
    AttributeName: str,
    KeyType: KeyTypeType,  # (1)
  1. See KeyTypeType

ListStreamsInputTypeDef#

# ListStreamsInputTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import ListStreamsInputTypeDef


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


# ListStreamsInputTypeDef definition

class ListStreamsInputTypeDef(TypedDict):
    TableName: NotRequired[str],
    Limit: NotRequired[int],
    ExclusiveStartStreamArn: NotRequired[str],

StreamTypeDef#

# StreamTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import StreamTypeDef


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


# StreamTypeDef definition

class StreamTypeDef(TypedDict):
    StreamArn: NotRequired[str],
    TableName: NotRequired[str],
    StreamLabel: NotRequired[str],

SequenceNumberRangeTypeDef#

# SequenceNumberRangeTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import SequenceNumberRangeTypeDef


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


# SequenceNumberRangeTypeDef definition

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

StreamRecordTypeDef#

# StreamRecordTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import StreamRecordTypeDef


def get_value() -> StreamRecordTypeDef:
    return {
        "ApproximateCreationDateTime": ...,
    }


# StreamRecordTypeDef definition

class StreamRecordTypeDef(TypedDict):
    ApproximateCreationDateTime: NotRequired[datetime.datetime],
    Keys: NotRequired[Dict[str, AttributeValueTypeDef]],  # (1)
    NewImage: NotRequired[Dict[str, AttributeValueTypeDef]],  # (1)
    OldImage: NotRequired[Dict[str, AttributeValueTypeDef]],  # (1)
    SequenceNumber: NotRequired[str],
    SizeBytes: NotRequired[int],
    StreamViewType: NotRequired[StreamViewTypeType],  # (4)
  1. See Dict[str, AttributeValueTypeDef]
  2. See Dict[str, AttributeValueTypeDef]
  3. See Dict[str, AttributeValueTypeDef]
  4. See StreamViewTypeType

DescribeStreamInputTypeDef#

# DescribeStreamInputTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import DescribeStreamInputTypeDef


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


# DescribeStreamInputTypeDef definition

class DescribeStreamInputTypeDef(TypedDict):
    StreamArn: str,
    Limit: NotRequired[int],
    ExclusiveStartShardId: NotRequired[str],
    ShardFilter: NotRequired[ShardFilterTypeDef],  # (1)
  1. See ShardFilterTypeDef

GetShardIteratorOutputTypeDef#

# GetShardIteratorOutputTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import GetShardIteratorOutputTypeDef


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


# GetShardIteratorOutputTypeDef definition

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

ListStreamsOutputTypeDef#

# ListStreamsOutputTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import ListStreamsOutputTypeDef


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


# ListStreamsOutputTypeDef definition

class ListStreamsOutputTypeDef(TypedDict):
    Streams: List[StreamTypeDef],  # (1)
    LastEvaluatedStreamArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[StreamTypeDef]
  2. See ResponseMetadataTypeDef

ShardTypeDef#

# ShardTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import ShardTypeDef


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


# ShardTypeDef definition

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

RecordTypeDef#

# RecordTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import RecordTypeDef


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


# RecordTypeDef definition

class RecordTypeDef(TypedDict):
    eventID: NotRequired[str],
    eventName: NotRequired[OperationTypeType],  # (1)
    eventVersion: NotRequired[str],
    eventSource: NotRequired[str],
    awsRegion: NotRequired[str],
    dynamodb: NotRequired[StreamRecordTypeDef],  # (2)
    userIdentity: NotRequired[IdentityTypeDef],  # (3)
  1. See OperationTypeType
  2. See StreamRecordTypeDef
  3. See IdentityTypeDef

StreamDescriptionTypeDef#

# StreamDescriptionTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import StreamDescriptionTypeDef


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


# StreamDescriptionTypeDef definition

class StreamDescriptionTypeDef(TypedDict):
    StreamArn: NotRequired[str],
    StreamLabel: NotRequired[str],
    StreamStatus: NotRequired[StreamStatusType],  # (1)
    StreamViewType: NotRequired[StreamViewTypeType],  # (2)
    CreationRequestDateTime: NotRequired[datetime.datetime],
    TableName: NotRequired[str],
    KeySchema: NotRequired[List[KeySchemaElementTypeDef]],  # (3)
    Shards: NotRequired[List[ShardTypeDef]],  # (4)
    LastEvaluatedShardId: NotRequired[str],
  1. See StreamStatusType
  2. See StreamViewTypeType
  3. See List[KeySchemaElementTypeDef]
  4. See List[ShardTypeDef]

GetRecordsOutputTypeDef#

# GetRecordsOutputTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.type_defs import GetRecordsOutputTypeDef


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


# GetRecordsOutputTypeDef definition

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

DescribeStreamOutputTypeDef#

# DescribeStreamOutputTypeDef TypedDict usage example

from types_boto3_dynamodbstreams.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