Skip to content

Record

Source code in docs_src/capo_dynamodb_streams/types/record.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class Record(TypedDict, closed=True):
    event_id: NotRequired["capo_dynamodb_streams.types.string.String"]
    """<p>A globally unique identifier for the event that was recorded in this stream record.</p>"""
    event_name: NotRequired["capo_dynamodb_streams.types.operation_type.OperationType"]
    """<p>The type of data modification that was performed on the DynamoDB table:</p> <ul> <li> <p> <code>INSERT</code> - a new item was added to the table.</p> </li> <li> <p> <code>MODIFY</code> - one or more of an existing item's attributes were modified.</p> </li> <li> <p> <code>REMOVE</code> - the item was deleted from the table</p> </li> </ul>"""
    event_version: NotRequired["capo_dynamodb_streams.types.string.String"]
    """<p>The version number of the stream record format. This number is updated whenever the structure of <code>Record</code> is modified.</p> <p>Client applications must not assume that <code>eventVersion</code> will remain at a particular value, as this number is subject to change at any time. In general, <code>eventVersion</code> will only increase as the low-level DynamoDB Streams API evolves.</p>"""
    event_source: NotRequired["capo_dynamodb_streams.types.string.String"]
    """<p>The Amazon Web Services service from which the stream record originated. For DynamoDB Streams, this is <code>aws:dynamodb</code>.</p>"""
    aws_region: NotRequired["capo_dynamodb_streams.types.string.String"]
    """<p>The region in which the <code>GetRecords</code> request was received.</p>"""
    dynamodb: NotRequired["capo_dynamodb_streams.types.stream_record.StreamRecord"]
    """<p>The main body of the stream record, containing all of the DynamoDB-specific fields.</p>"""
    user_identity: NotRequired["capo_dynamodb_streams.types.identity.Identity"]
    """<p>Items that are deleted by the Time to Live process after expiration have the following fields: </p> <ul> <li> <p>Records[].userIdentity.type</p> <p>"Service"</p> </li> <li> <p>Records[].userIdentity.principalId</p> <p>"dynamodb.amazonaws.com"</p> </li> </ul>"""

aws_region instance-attribute 

aws_region: NotRequired[String]

The region in which the GetRecords request was received.

dynamodb instance-attribute 

dynamodb: NotRequired[StreamRecord]

The main body of the stream record, containing all of the DynamoDB-specific fields.

event_id instance-attribute 

event_id: NotRequired[String]

A globally unique identifier for the event that was recorded in this stream record.

event_name instance-attribute 

event_name: NotRequired[OperationType]

The type of data modification that was performed on the DynamoDB table:

  • INSERT - a new item was added to the table.

  • MODIFY - one or more of an existing item's attributes were modified.

  • REMOVE - the item was deleted from the table

event_source instance-attribute 

event_source: NotRequired[String]

The Amazon Web Services service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.

event_version instance-attribute 

event_version: NotRequired[String]

The version number of the stream record format. This number is updated whenever the structure of Record is modified.

Client applications must not assume that eventVersion will remain at a particular value, as this number is subject to change at any time. In general, eventVersion will only increase as the low-level DynamoDB Streams API evolves.

user_identity instance-attribute 

user_identity: NotRequired[Identity]

Items that are deleted by the Time to Live process after expiration have the following fields:

  • Records[].userIdentity.type

    "Service"

  • Records[].userIdentity.principalId

    "dynamodb.amazonaws.com"