Skip to content

KeySchemaElement

Source code in docs_src/capo_dynamodb_streams/types/key_schema_element.py 
14
15
16
17
18
19
20
class KeySchemaElement(TypedDict, closed=True):
    attribute_name: (
        "capo_dynamodb_streams.types.key_schema_attribute_name.KeySchemaAttributeName"
    )
    """<p>The name of a key attribute.</p>"""
    key_type: "capo_dynamodb_streams.types.key_type.KeyType"
    """<p>The role that this key attribute will assume:</p> <ul> <li> <p> <code>HASH</code> - partition key</p> </li> <li> <p> <code>RANGE</code> - sort key</p> </li> </ul> <note> <p>The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.</p> <p>The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</p> </note>"""

attribute_name instance-attribute 

attribute_name: KeySchemaAttributeName

The name of a key attribute.

key_type instance-attribute 

key_type: KeyType

The role that this key attribute will assume:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.