Skip to content

PartitionIndexDescriptor

Source code in docs_src/capo_glue/types/partition_index_descriptor.py 
16
17
18
19
20
21
22
23
24
class PartitionIndexDescriptor(TypedDict, closed=True):
    index_name: "capo_glue.types.name_string.NameString"
    """<p>The name of the partition index.</p>"""
    keys: "capo_glue.types.key_schema_element_list.KeySchemaElementList"
    """<p>A list of one or more keys, as <code>KeySchemaElement</code> structures, for the partition index.</p>"""
    index_status: "capo_glue.types.partition_index_status.PartitionIndexStatus"
    """<p>The status of the partition index. </p> <p>The possible statuses are:</p> <ul> <li> <p>CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.</p> </li> <li> <p>ACTIVE: The index creation succeeds.</p> </li> <li> <p>FAILED: The index creation fails. </p> </li> <li> <p>DELETING: The index is deleted from the list of indexes.</p> </li> </ul>"""
    backfill_errors: NotRequired["capo_glue.types.backfill_errors.BackfillErrors"]
    """<p>A list of errors that can occur when registering partition indexes for an existing table.</p>"""

backfill_errors instance-attribute 

backfill_errors: NotRequired[BackfillErrors]

A list of errors that can occur when registering partition indexes for an existing table.

index_name instance-attribute 

index_name: NameString

The name of the partition index.

index_status instance-attribute 

index_status: PartitionIndexStatus

The status of the partition index.

The possible statuses are:

  • CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.

  • ACTIVE: The index creation succeeds.

  • FAILED: The index creation fails.

  • DELETING: The index is deleted from the list of indexes.

keys instance-attribute 

keys: KeySchemaElementList

A list of one or more keys, as KeySchemaElement structures, for the partition index.