GlobalSecondaryIndexDescription¶
Structure Class¶
dataclass
¶
Represents the properties of a global secondary index.
Attributes¶
class-attribute
instance-attribute
¶
backfilling: bool | None = None
Indicates whether the index is currently backfilling. Backfilling is
the process of reading items from the table and determining whether they
can be added to the index. (Not all items will qualify: For example, a
partition key cannot have any duplicate values.) If an item can be added
to the index, DynamoDB will do so. After all items have been processed,
the backfilling operation is complete and Backfilling is false.
You can delete an index that is being created during the Backfilling
phase when IndexStatus is set to CREATING and Backfilling is true.
You can't delete the index that is being created when IndexStatus is
set to CREATING and Backfilling is false.
Note
For indexes that were created during a CreateTable operation, the
Backfilling attribute does not appear in the DescribeTable output.
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
The name of the global 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
¶
index_status: IndexStatus | None = None
The current state of the global secondary index:
-
CREATING- The index is being created. -
UPDATING- The index is being updated. -
DELETING- The index is being deleted. -
ACTIVE- The index is ready for use.
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 a global secondary index, which consists 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
¶
on_demand_throughput: OnDemandThroughput | None = None
The maximum number of read and write units for the specified global
secondary index. If you use this parameter, you must specify
MaxReadRequestUnits, MaxWriteRequestUnits, or both.
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.
class-attribute
instance-attribute
¶
provisioned_throughput: ProvisionedThroughputDescription | None = None
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
class-attribute
instance-attribute
¶
warm_throughput: GlobalSecondaryIndexWarmThroughputDescription | None = None
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.