AWS SDK Version 3 for .NET
API Reference

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.

Classes

NameDescription
Class AccessDeniedException

The credentials that you used to call this operation don't have the minimum required permissions.

Class 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 Search operation performed in that Region.

Class AssociateDefaultViewResponse

This is the response object from the AssociateDefaultView operation.

Class BatchGetViewError

A collection of error messages for any views that Amazon Web Services Resource Explorer couldn't retrieve details.

Class BatchGetViewRequest

Container for the parameters to the BatchGetView operation. Retrieves details about a list of views.

Class BatchGetViewResponse

This is the response object from the BatchGetView operation.

Class 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 AGGREGATOR, then the request failed because you already have an AGGREGATOR index in a different Amazon Web Services Region.

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

  • Action: resource-explorer-2:CreateIndex

    Resource: The ARN of the index (as it will exist after the operation completes) in the Amazon Web Services Region and account in which you're trying to create the index. Use the wildcard character (*) at the end of the string to match the eventual UUID. For example, the following Resource element restricts the role or user to creating an index in only the us-east-2 Region of the specified account.

    "Resource": "arn:aws:resource-explorer-2:us-west-2::index/*"

    Alternatively, you can use "Resource": "*" to allow the role or user to create an index in any Region.

  • Action: iam:CreateServiceLinkedRole

    Resource: No specific resource (*).

    This permission is required only the first time you create an index to turn on Resource Explorer in the account. Resource Explorer uses this to create the service-linked role needed to index the resources in your account. Resource Explorer uses the same service-linked role for all additional indexes you create afterwards.

Class CreateIndexResponse

This is the response object from the CreateIndex operation.

Class 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 Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views in the Amazon Web Services Resource Explorer User Guide.

Only the principals with an IAM identity-based policy that grants Allow to the Search action on a Resource with the Amazon resource name (ARN) of this view can Search using views you create with this operation.

Class CreateViewResponse

This is the response object from the CreateView operation.

Class 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 Status response value.

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.

Class DeleteIndexResponse

This is the response object from the DeleteIndex operation.

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

Class DeleteViewResponse

This is the response object from the DeleteView operation.

Class 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 Search operation performed in that Region.

Class DisassociateDefaultViewResponse

This is the response object from the DisassociateDefaultView operation.

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

Class GetAccountLevelServiceConfigurationResponse

This is the response object from the GetAccountLevelServiceConfiguration operation.

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

Class GetDefaultViewResponse

This is the response object from the GetDefaultView operation.

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

Class GetIndexResponse

This is the response object from the GetIndex operation.

Class GetManagedViewRequest

Container for the parameters to the GetManagedView operation. Retrieves details of the specified Amazon Web Services-managed view.

Class GetManagedViewResponse

This is the response object from the GetManagedView operation.

Class GetViewRequest

Container for the parameters to the GetView operation. Retrieves details of the specified view.

Class GetViewResponse

This is the response object from the GetView operation.

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

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

Class InternalServerException

The request failed because of internal service error. Try your request again later.

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

Class ListIndexesForMembersResponse

This is the response object from the ListIndexesForMembers operation.

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

Class ListIndexesResponse

This is the response object from the ListIndexes operation.

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

Class ListManagedViewsResponse

This is the response object from the ListManagedViews operation.

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

Class ListResourcesResponse

This is the response object from the ListResources operation.

Class ListSupportedResourceTypesRequest

Container for the parameters to the ListSupportedResourceTypes operation. Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.

Class ListSupportedResourceTypesResponse

This is the response object from the ListSupportedResourceTypes operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists the tags that are attached to the specified resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class 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 NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

Class ListViewsResponse

This is the response object from the ListViews operation.

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

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

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

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

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

Class ResourceExplorer2PaginatorFactory

Paginators for the ResourceExplorer2 service

Class ResourceNotFoundException

You specified a resource that doesn't exist. Check the ID or ARN that you used to identity the resource, and try again.

Class ResourceProperty

A structure that describes a property of a resource.

Class SearchFilter

A search filter defines which resources can be part of a search query result set.

Class 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 QueryString parameter supplied to this operation and the SearchFilter parameter attached to the view.

For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.

If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search.

Class SearchResponse

This is the response object from the Search operation.

Class ServiceQuotaExceededException

The request failed because it exceeds a service quota.

Class SupportedResourceType

A structure that describes a resource type supported by Amazon Web Services Resource Explorer.

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

Class TagResourceResponse

This is the response object from the TagResource operation.

Class ThrottlingException

The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.

Class UnauthorizedException

The principal making the request isn't permitted to perform the operation.

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

Class UntagResourceResponse

This is the response object from the UntagResource operation.

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

  • AGGREGATOR index type

    The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. Resource information from all other Regions is replicated to this Region's index.

    When you change the index type to AGGREGATOR, Resource Explorer turns on replication of all discovered resource information from the other Amazon Web Services Regions in your account to this index. You can then, from this Region only, perform resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account. Turning on replication from all other Regions is performed by asynchronous background tasks. You can check the status of the asynchronous tasks by using the GetIndex operation. When the asynchronous tasks complete, the Status response of that operation changes from UPDATING to ACTIVE. After that, you can start to see results from other Amazon Web Services Regions in query results. However, it can take several hours for replication from all other Regions to complete.

    You can have only one aggregator index per Amazon Web Services account. Before you can promote a different index to be the aggregator index for the account, you must first demote the existing aggregator index to type LOCAL.

  • LOCAL index type

    The index contains information about resources in only the Amazon Web Services Region in which the index exists. If an aggregator index in another Region exists, then information in this local index is replicated to the aggregator index.

    When you change the index type to LOCAL, Resource Explorer turns off the replication of resource information from all other Amazon Web Services Regions in the Amazon Web Services account to this Region. The aggregator index remains in the UPDATING state until all replication with other Regions successfully stops. You can check the status of the asynchronous task by using the GetIndex operation. When Resource Explorer successfully stops all replication with other Regions, the Status response of that operation changes from UPDATING to ACTIVE. Separately, the resource information from other Regions that was previously stored in the index is deleted within 30 days by another background task. Until that asynchronous task completes, some results from other Regions can continue to appear in search results.

    After you demote an aggregator index to a local index, you must wait 24 hours before you can promote another index to be the new aggregator index for the account.

Class UpdateIndexTypeResponse

This is the response object from the UpdateIndexType operation.

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

Class UpdateViewResponse

This is the response object from the UpdateView operation.

Class ValidationException

You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.

Class ValidationExceptionField

A structure that describes a request field with a validation error.

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

Interfaces

NameDescription
Interface IListIndexesForMembersPaginator

Paginator for the ListIndexesForMembers operation

Interface IListIndexesPaginator

Paginator for the ListIndexes operation

Interface IListManagedViewsPaginator

Paginator for the ListManagedViews operation

Interface IListResourcesPaginator

Paginator for the ListResources operation

Interface IListSupportedResourceTypesPaginator

Paginator for the ListSupportedResourceTypes operation

Interface IListViewsPaginator

Paginator for the ListViews operation

Interface IResourceExplorer2PaginatorFactory

Paginators for the ResourceExplorer2 service

Interface ISearchPaginator

Paginator for the Search operation