Skip to content

IndexConfigurationSummary

Source code in docs_src/capo_kendra/types/index_configuration_summary.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class IndexConfigurationSummary(TypedDict, closed=True):
    name: NotRequired["capo_kendra.types.index_name.IndexName"]
    """<p>The name of the index.</p>"""
    id: NotRequired["capo_kendra.types.index_id.IndexId"]
    """<p>A identifier for the index. Use this to identify the index when you are using APIs such as <code>Query</code>, <code>DescribeIndex</code>, <code>UpdateIndex</code>, and <code>DeleteIndex</code>.</p>"""
    edition: NotRequired["capo_kendra.types.index_edition.IndexEdition"]
    """<p>Indicates whether the index is a Enterprise Edition index or a Developer Edition index. </p>"""
    created_at: "capo_kendra.types.timestamp.Timestamp"
    """<p>The Unix timestamp when the index was created.</p>"""
    updated_at: "capo_kendra.types.timestamp.Timestamp"
    """<p>The Unix timestamp when the index was last updated.</p>"""
    status: "capo_kendra.types.index_status.IndexStatus"
    """<p>The current status of the index. When the status is <code>ACTIVE</code>, the index is ready to search.</p>"""

created_at instance-attribute 

created_at: Timestamp

The Unix timestamp when the index was created.

edition instance-attribute 

edition: NotRequired[IndexEdition]

Indicates whether the index is a Enterprise Edition index or a Developer Edition index.

id instance-attribute 

id: NotRequired[IndexId]

A identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

name instance-attribute 

name: NotRequired[IndexName]

The name of the index.

status instance-attribute 

status: IndexStatus

The current status of the index. When the status is ACTIVE, the index is ready to search.

updated_at instance-attribute 

updated_at: Timestamp

The Unix timestamp when the index was last updated.