Amazon Web Services, Inc.

AWS Resource Explorer

Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet search engine-like experience. Examples of resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your resources using resource metadata like names, tags, and IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn the service on, to simplify your cross-Region workloads. Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which you turn on Resource Explorer. Resource Explorer creates and maintains an index in each Region, with the details of that Region's resources. You can search across all of the indexed Regions in your account by designating one of your Amazon Web Services Regions to contain the aggregator index for the account. When you promote a local index in a Region to become the aggregator index for the account , Resource Explorer automatically replicates the index information from all local indexes in the other Regions to the aggregator index. Therefore, the Region with the aggregator index has a copy of all resource information for all Regions in the account where you turned on Resource Explorer. As a result, views in the aggregator index Region include resources from all of the indexed Regions in your account. For more information about Amazon Web Services Resource Explorer, including how to enable and configure the service, see the Amazon Web Services Resource Explorer User Guide .

Endpoints 32

Default view association

  • POSTAssociate default view/AssociateDefaultViewSets 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…

Cfn index

  • POSTCreate index/CreateIndexTurns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer…
  • POSTDelete index/DeleteIndexDeletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region. When you delete an index,…
  • POSTList indexes/ListIndexesRetrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource…
  • POSTUpdate index type/UpdateIndexTypeChanges 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…

Cfn view

  • POSTCreate view/CreateViewCreates 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…
  • POSTDelete view/DeleteViewDeletes 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…
  • POSTGet view/GetViewRetrieves details of the specified view.
  • POSTList views/ListViewsLists 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…
  • POSTUpdate view/UpdateViewModifies 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.
  • POSTBatch get view/BatchGetViewRetrieves details about a list of views.
  • POSTCreate resource explorer setup/CreateResourceExplorerSetupCreates a Resource Explorer setup configuration across multiple Amazon Web Services Regions. This operation sets up indexes and views in the specified…
  • POSTDelete resource explorer setup/DeleteResourceExplorerSetupDeletes a Resource Explorer setup configuration. This operation removes indexes and views from the specified Regions or all Regions where Resource Explorer is…
  • POSTDisassociate default view/DisassociateDefaultViewAfter you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly…
  • POSTGet account level service configuration/GetAccountLevelServiceConfigurationRetrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search…
  • POSTGet default view/GetDefaultViewRetrieves 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…
  • POSTGet index/GetIndexRetrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.
  • POSTGet managed view/GetManagedViewRetrieves details of the specified Amazon Web Services-managed view .
  • POSTGet resource explorer setup/GetResourceExplorerSetupRetrieves the status and details of a Resource Explorer setup operation. This operation returns information about the progress of creating or deleting…
  • POSTGet service index/GetServiceIndexRetrieves information about the Resource Explorer index in the current Amazon Web Services Region. This operation returns the ARN and type of the index if one…
  • POSTGet service view/GetServiceViewRetrieves details about a specific Resource Explorer service view. This operation returns the configuration and properties of the specified view.
  • POSTList indexes for members/ListIndexesForMembersRetrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource…
  • POSTList managed views/ListManagedViewsLists 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.
  • POSTList resources/ListResourcesReturns 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…
  • POSTList service indexes/ListServiceIndexesLists all Resource Explorer indexes across the specified Amazon Web Services Regions. This operation returns information about indexes including their ARNs,…
  • POSTList service views/ListServiceViewsLists all Resource Explorer service views available in the current Amazon Web Services account. This operation returns the ARNs of available service views.
  • POSTList streaming access for services/ListStreamingAccessForServicesReturns a list of Amazon Web Services services that have been granted streaming access to your Resource Explorer data. Streaming access allows Amazon Web…
  • POSTList supported resource types/ListSupportedResourceTypesRetrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.
  • GETList tags for resource/tags/:resourceArnLists the tags that are attached to the specified resource.
  • POSTTag resource/tags/:resourceArnAdds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.
  • POSTSearch/SearchSearches for resources and displays details about all resources that match the specified criteria. You must specify a query string. All search queries must…

API details

Base URL
https://resource-explorer-2.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
32 operations on 30 pathsPOST 30GET 1DELETE 1
Main resources
Cfn view 5Cfn index 4Default view association 1
Description format
AWS Smithy model, API version 2022-07-28

How to test the AWS Resource Explorer in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Resource Explorer collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate default view” (POST /AssociateDefaultView), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Resource Explorer?

Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet… It is listed under Developer tools and has 32 endpoints.

Who publishes the AWS Resource Explorer?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Resource Explorer?

Requests go to https://resource-explorer-2.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Resource Explorer?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Resource Explorer have?

32 operations on 30 paths (30 POST, 1 GET, 1 DELETE). The largest groups are Cfn view, Cfn index, Default view association.

Is forking the AWS Resource Explorer free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.