Skip to content

StreamRecord

Source code in docs_src/capo_dynamodb_streams/types/stream_record.py
class StreamRecord(TypedDict, closed=True):
    approximate_creation_date_time: NotRequired["capo_dynamodb_streams.types.date.Date"]
    """<p>The approximate date and time when the stream record was created, in <a href="http://www.epochconverter.com/">UNIX epoch time</a> format and rounded down to the closest second. Some tools and SDKs may convert this value to a different format, such as <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>.</p>"""
    keys: NotRequired["capo_dynamodb_streams.types.attribute_map.AttributeMap"]
    """<p>The primary key attribute(s) for the DynamoDB item that was modified.</p>"""
    new_image: NotRequired["capo_dynamodb_streams.types.attribute_map.AttributeMap"]
    """<p>The item in the DynamoDB table as it appeared after it was modified.</p>"""
    old_image: NotRequired["capo_dynamodb_streams.types.attribute_map.AttributeMap"]
    """<p>The item in the DynamoDB table as it appeared before it was modified.</p>"""
    sequence_number: NotRequired[
        "capo_dynamodb_streams.types.sequence_number.SequenceNumber"
    ]
    """<p>The sequence number of the stream record.</p>"""
    size_bytes: NotRequired[
        "capo_dynamodb_streams.types.positive_long_object.PositiveLongObject"
    ]
    """<p>The size of the stream record, in bytes.</p>"""
    stream_view_type: NotRequired[
        "capo_dynamodb_streams.types.stream_view_type.StreamViewType"
    ]
    """<p>The type of data from the modified DynamoDB item that was captured in this stream record:</p> <ul> <li> <p> <code>KEYS_ONLY</code> - only the key attributes of the modified item.</p> </li> <li> <p> <code>NEW_IMAGE</code> - the entire item, as it appeared after it was modified.</p> </li> <li> <p> <code>OLD_IMAGE</code> - the entire item, as it appeared before it was modified.</p> </li> <li> <p> <code>NEW_AND_OLD_IMAGES</code> - both the new and the old item images of the item.</p> </li> </ul>"""

approximate_creation_date_time instance-attribute

approximate_creation_date_time: NotRequired[Date]

The approximate date and time when the stream record was created, in UNIX epoch time format and rounded down to the closest second. Some tools and SDKs may convert this value to a different format, such as ISO 8601.

keys instance-attribute

keys: NotRequired[AttributeMap]

The primary key attribute(s) for the DynamoDB item that was modified.

new_image instance-attribute

new_image: NotRequired[AttributeMap]

The item in the DynamoDB table as it appeared after it was modified.

old_image instance-attribute

old_image: NotRequired[AttributeMap]

The item in the DynamoDB table as it appeared before it was modified.

sequence_number instance-attribute

sequence_number: NotRequired[SequenceNumber]

The sequence number of the stream record.

size_bytes instance-attribute

size_bytes: NotRequired[PositiveLongObject]

The size of the stream record, in bytes.

stream_view_type instance-attribute

stream_view_type: NotRequired[StreamViewType]

The type of data from the modified DynamoDB item that was captured in this stream record:

  • KEYS_ONLY - only the key attributes of the modified item.

  • NEW_IMAGE - the entire item, as it appeared after it was modified.

  • OLD_IMAGE - the entire item, as it appeared before it was modified.

  • NEW_AND_OLD_IMAGES - both the new and the old item images of the item.