AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AccessDeniedException |
The credentials that you used to call this operation don't have the minimum required permissions. |
|
AssociateDefaultViewRequest |
Container for the parameters to the AssociateDefaultView operation. Sets the specified view as the default for the Amazon Web Services Region in which you call this operation. When a user performs a Search that doesn't explicitly specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for searches performed in this Amazon Web Services Region.
If an Amazon Web Services Region doesn't have a default view configured, then users
must explicitly specify a view with every |
|
AssociateDefaultViewResponse |
This is the response object from the AssociateDefaultView operation. |
|
BatchGetViewError |
A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve details. |
|
BatchGetViewRequest |
Container for the parameters to the BatchGetView operation. Retrieves details about a list of views. |
|
BatchGetViewResponse |
This is the response object from the BatchGetView operation. |
|
ConflictException |
If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the original request, or you attempted to create a view with a name that already exists in this Amazon Web Services Region. If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current Amazon Web Services Region.
If you attempted to update an index type to |
|
CreateIndexRequest |
Container for the parameters to the CreateIndex operation.
Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in
which you called this operation by creating an index. Resource Explorer begins discovering
the resources in this Region and stores the details about the resources in the index
so that they can be queried by using the Search operation. You can create only
one index in a Region.
This operation creates only a local index. To promote the local index in one
Amazon Web Services Region into the aggregator index for the Amazon Web Services account,
use the UpdateIndexType operation. For more information, see Turning
on cross-Region search by creating an aggregator index in the Amazon Web Services
Resource Explorer User Guide.
For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turn on Resource Explorer to index your resources in an Amazon Web Services Region in the Amazon Web Services Resource Explorer User Guide. If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then this operation also creates a service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate your resources to populate the index.
|
|
CreateIndexResponse |
This is the response object from the CreateIndex operation. |
|
CreateViewRequest |
Container for the parameters to the CreateView operation.
Creates a view that users can query by using the Search operation. Results
from queries that you make using this view include only resources that match the view's
Only the principals with an IAM identity-based policy that grants |
|
CreateViewResponse |
This is the response object from the CreateView operation. |
|
DeleteIndexRequest |
Container for the parameters to the DeleteIndex operation.
Deletes the specified index and turns off Amazon Web Services Resource Explorer in
the specified Amazon Web Services Region. When you delete an index, Resource Explorer
stops discovering and indexing resources in that Region. Resource Explorer also deletes
all views in that Region. These actions occur as asynchronous background tasks. You
can check to see when the actions are complete by using the GetIndex operation
and checking the
If the index you delete is the aggregator index for the Amazon Web Services account,
you must wait 24 hours before you can promote another local index to be the aggregator
index for the account. Users can't perform account-wide searches using Resource Explorer
until another aggregator index is configured.
|
|
DeleteIndexResponse |
This is the response object from the DeleteIndex operation. |
|
DeleteViewRequest |
Container for the parameters to the DeleteView operation. Deletes the specified view. If the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use until you configure a new default by calling the AssociateDefaultView operation. |
|
DeleteViewResponse |
This is the response object from the DeleteView operation. |
|
DisassociateDefaultViewRequest |
Container for the parameters to the DisassociateDefaultView operation. After you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly specify a view or the operation fails. You can configure a new default by calling the AssociateDefaultView operation.
If an Amazon Web Services Region doesn't have a default view configured, then users
must explicitly specify a view with every |
|
DisassociateDefaultViewResponse |
This is the response object from the DisassociateDefaultView operation. |
|
GetAccountLevelServiceConfigurationRequest |
Container for the parameters to the GetAccountLevelServiceConfiguration operation. Retrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature. Only the management account can invoke this API call. |
|
GetAccountLevelServiceConfigurationResponse |
This is the response object from the GetAccountLevelServiceConfiguration operation. |
|
GetDefaultViewRequest |
Container for the parameters to the GetDefaultView operation. Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web Services Region in which you call this operation. You can then call GetView to retrieve the details of that view. |
|
GetDefaultViewResponse |
This is the response object from the GetDefaultView operation. |
|
GetIndexRequest |
Container for the parameters to the GetIndex operation. Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation. |
|
GetIndexResponse |
This is the response object from the GetIndex operation. |
|
GetManagedViewRequest |
Container for the parameters to the GetManagedView operation. Retrieves details of the specified Amazon Web Services-managed view. |
|
GetManagedViewResponse |
This is the response object from the GetManagedView operation. |
|
GetViewRequest |
Container for the parameters to the GetView operation. Retrieves details of the specified view. |
|
GetViewResponse |
This is the response object from the GetView operation. |
|
IncludedProperty |
Information about an additional property that describes a resource, that you can optionally include in the view. This lets you view that property in search results, and filter your search results based on the value of the property. |
|
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. |
|
InternalServerException |
The request failed because of internal service error. Try your request again later. |
|
ListIndexesForMembersRequest |
Container for the parameters to the ListIndexesForMembers operation. Retrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer. Only the management account or a delegated administrator with service access enabled can invoke this API call. |
|
ListIndexesForMembersResponse |
This is the response object from the ListIndexesForMembers operation. |
|
ListIndexesRequest |
Container for the parameters to the ListIndexes operation. Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer. |
|
ListIndexesResponse |
This is the response object from the ListIndexes operation. |
|
ListManagedViewsRequest |
Container for the parameters to the ListManagedViews operation. Lists the Amazon resource names (ARNs) of the Amazon Web Services-managed views available in the Amazon Web Services Region in which you call this operation. |
|
ListManagedViewsResponse |
This is the response object from the ListManagedViews operation. |
|
ListResourcesRequest |
Container for the parameters to the ListResources operation. Returns a list of resources and their details that match the specified criteria. This query must use a view. If you don’t explicitly specify a view, then Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. |
|
ListResourcesResponse |
This is the response object from the ListResources operation. |
|
ListSupportedResourceTypesRequest |
Container for the parameters to the ListSupportedResourceTypes operation. Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer. |
|
ListSupportedResourceTypesResponse |
This is the response object from the ListSupportedResourceTypes operation. |
|
ListTagsForResourceRequest |
Container for the parameters to the ListTagsForResource operation. Lists the tags that are attached to the specified resource. |
|
ListTagsForResourceResponse |
This is the response object from the ListTagsForResource operation. |
|
ListViewsRequest |
Container for the parameters to the ListViews operation.
Lists the Amazon
resource names (ARNs) of the views available in the Amazon Web Services Region
in which you call this operation.
Always check the |
|
ListViewsResponse |
This is the response object from the ListViews operation. |
|
ManagedView |
An Amazon Web Services-managed view is how other Amazon Web Services services can access resource information indexed by Resource Explorer for your Amazon Web Services account or organization with your consent. For more information, see Managed views. |
|
MemberIndex |
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. |
|
OrgConfiguration |
This is a structure that contains the status of Amazon Web Services service access, and whether you have a valid service-linked role to enable multi-account search for your organization. |
|
Resource |
A resource in Amazon Web Services that Amazon Web Services Resource Explorer has discovered, and for which it has stored information in the index of the Amazon Web Services Region that contains the resource. |
|
ResourceCount |
Information about the number of results that match the query. At this time, Amazon Web Services Resource Explorer doesn't count more than 1,000 matches for any query. This structure provides information about whether the query exceeded this limit. This field is included in every page when you paginate the results. |
|
ResourceExplorer2PaginatorFactory |
Paginators for the ResourceExplorer2 service |
|
ResourceNotFoundException |
You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again. |
|
ResourceProperty |
A structure that describes a property of a resource. |
|
SearchFilter |
A search filter defines which resources can be part of a search query result set. |
|
SearchRequest |
Container for the parameters to the Search operation. Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.
All search queries must use a view. If you don't explicitly specify a view, then Amazon
Web Services Resource Explorer uses the default view for the Amazon Web Services Region
in which you call this operation. The results are the logical intersection of the
results that match both the
For the complete syntax supported by the If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search. |
|
SearchResponse |
This is the response object from the Search operation. |
|
ServiceQuotaExceededException |
The request failed because it exceeds a service quota. |
|
SupportedResourceType |
A structure that describes a resource type supported by Amazon Web Services Resource Explorer. |
|
TagResourceRequest |
Container for the parameters to the TagResource operation. Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index. |
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
ThrottlingException |
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer. |
|
UnauthorizedException |
The principal making the request isn't permitted to perform the operation. |
|
UntagResourceRequest |
Container for the parameters to the UntagResource operation. Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index. |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
UpdateIndexTypeRequest |
Container for the parameters to the UpdateIndexType operation. Changes the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide.
|
|
UpdateIndexTypeResponse |
This is the response object from the UpdateIndexType operation. |
|
UpdateViewRequest |
Container for the parameters to the UpdateView operation. Modifies some of the details of a view. You can change the filter string and the list of included properties. You can't change the name of the view. |
|
UpdateViewResponse |
This is the response object from the UpdateView operation. |
|
ValidationException |
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again. |
|
ValidationExceptionField |
A structure that describes a request field with a validation error. |
|
View |
A view is a structure that defines a set of filters that provide a view into the information in the Amazon Web Services Resource Explorer index. The filters specify which information from the index is visible to the users of the view. For example, you can specify filters that include only resources that are tagged with the key "ENV" and the value "DEVELOPMENT" in the results returned by this view. You could also create a second view that includes only resources that are tagged with "ENV" and "PRODUCTION". |
Name | Description | |
---|---|---|
IListIndexesForMembersPaginator |
Paginator for the ListIndexesForMembers operation |
|
IListIndexesPaginator |
Paginator for the ListIndexes operation |
|
IListManagedViewsPaginator |
Paginator for the ListManagedViews operation |
|
IListResourcesPaginator |
Paginator for the ListResources operation |
|
IListSupportedResourceTypesPaginator |
Paginator for the ListSupportedResourceTypes operation |
|
IListViewsPaginator |
Paginator for the ListViews operation |
|
IResourceExplorer2PaginatorFactory |
Paginators for the ResourceExplorer2 service |
|
ISearchPaginator |
Paginator for the Search operation |