Class: Aws::ResourceExplorer2::Types::IndexStatus

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#error_details ⇒ Types::ErrorDetails

Details about any error that occurred during the index operation.

Returns:



836
837
838
839
840
841
842
 
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb', line 836

class IndexStatus < Struct.new(
  :status,
  :index,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#index ⇒ Types::Index

An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services 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.

Returns:



836
837
838
839
840
841
842
 
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb', line 836

class IndexStatus < Struct.new(
  :status,
  :index,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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

Returns:

  • (String) 


836
837
838
839
840
841
842
 
# File 'gems/aws-sdk-resourceexplorer2/lib/aws-sdk-resourceexplorer2/types.rb', line 836

class IndexStatus < Struct.new(
  :status,
  :index,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end