Skip to content

GetIndexOutput

Source code in docs_src/capo_resource_explorer_2/types/get_index_output.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class GetIndexOutput(TypedDict, closed=True):
    arn: NotRequired["str"]
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the index.</p>"""
    type: NotRequired["capo_resource_explorer_2.types.index_type.IndexType"]
    """<p>The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html">Turning on cross-Region search by creating an aggregator index</a>.</p>"""
    state: NotRequired["capo_resource_explorer_2.types.index_state.IndexState"]
    """<p>The current state of the index in this Amazon Web Services Region.</p>"""
    replicating_from: NotRequired[
        "capo_resource_explorer_2.types.region_list.RegionList"
    ]
    """<p>This response value is present only if this index is <code>Type=AGGREGATOR</code>.</p> <p>A list of the Amazon Web Services Regions that replicate their content to the index in this Region.</p>"""
    replicating_to: NotRequired["capo_resource_explorer_2.types.region_list.RegionList"]
    """<p>This response value is present only if this index is <code>Type=LOCAL</code>.</p> <p>The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value. </p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time when the index was originally created.</p>"""
    last_updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time when the index was last updated.</p>"""
    tags: NotRequired["capo_resource_explorer_2.types.tag_map.TagMap"]
    """<p>Tag key and value pairs that are attached to the index.</p>"""

arn instance-attribute 

arn: NotRequired[str]

The Amazon resource name (ARN) of the index.

created_at instance-attribute 

created_at: NotRequired[datetime]

The date and time when the index was originally created.

last_updated_at instance-attribute 

last_updated_at: NotRequired[datetime]

The date and time when the index was last updated.

replicating_from instance-attribute 

replicating_from: NotRequired[RegionList]

This response value is present only if this index is Type=AGGREGATOR.

A list of the Amazon Web Services Regions that replicate their content to the index in this Region.

replicating_to instance-attribute 

replicating_to: NotRequired[RegionList]

This response value is present only if this index is Type=LOCAL.

The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.

state instance-attribute 

state: NotRequired[IndexState]

The current state of the index in this Amazon Web Services Region.

tags instance-attribute 

tags: NotRequired[TagMap]

Tag key and value pairs that are attached to the index.

type instance-attribute 

type: NotRequired[IndexType]

The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.