LocalSecondaryIndexDescription¶
Structure Class¶
dataclass
¶
Represents the properties of a local secondary index.
Attributes¶
class-attribute
instance-attribute
¶
index_arn: str | None = None
The Amazon Resource Name (ARN) that uniquely identifies the index.
class-attribute
instance-attribute
¶
index_name: str | None = None
Represents the name of the local secondary index.
class-attribute
instance-attribute
¶
index_size_bytes: int | None = None
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
class-attribute
instance-attribute
¶
item_count: int | None = None
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
class-attribute
instance-attribute
¶
key_schema: list[KeySchemaElement] | None = None
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
-
HASH- partition key -
RANGE- sort key
Note
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.
class-attribute
instance-attribute
¶
projection: Projection | None = None
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.