Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1432170162.4 KB

Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.

post/GetIndex

Response

Success

Arnstring

The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the index.

Type'LOCAL' | 'AGGREGATOR'

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>.

State'CREATING' | 'ACTIVE' | 'DELETING' | 'DELETED' | 'UPDATING'

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

ReplicatingFromRegionListMemberString[]
<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>
ReplicatingToRegionListMemberString[]
<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>
CreatedAtstring date-time

The date and time when the index was originally created.

LastUpdatedAtstring date-time

The date and time when the index was last updated.

Tagsobject

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