IndexStatus - AWS Resource Explorer

IndexStatus

Contains information about the status of a Resource Explorer index operation in a specific Region.

Contents

Note

In the following list, the required parameters are described first.

ErrorDetails

Details about any error that occurred during the index operation.

Type: ErrorDetails object

Required: No

Index

An index is the data store used by AWS Resource Explorer to hold information about your AWS resources that the service discovers. Creating an index in an AWS Region turns on Resource Explorer and lets it discover your resources.

By default, an index is local, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.

Type: Index object

Required: No

Status

The current status of the index operation. Valid values are SUCCEEDED, FAILED, IN_PROGRESS, or SKIPPED.

Type: String

Valid Values: SUCCEEDED | FAILED | IN_PROGRESS | SKIPPED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: