View a markdown version of this page

Turning off Resource Explorer - Amazon Resource Explorer
Turning off Resource Explorer in one Amazon Web Services RegionTurning off all Amazon Web Services Regions
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Turning off Resource Explorer

When you no longer need to search for resources in a specific Amazon Web Services Region, you can turn off Amazon Resource Explorer in only that Region by deleting its index, or you can delete Resource Explorer in all Amazon Web Services Regions. When you do this, Resource Explorer stops scanning for new or updated resources in that Region. If your account contains an aggregator index, then replication from the deleted index stops, and the information from the deleted index is removed from the aggregator index and stops appearing in search results. It can take up to 24 hours for all resources from the deleted index to disappear from search results in the Region with the aggregator index.

Note

When you register the first Amazon Web Services Region, Resource Explorer creates a service linked role (SLR) named AWSServiceRoleForResourceExplorer in the Amazon Web Services account. Resource Explorer doesn't delete this SLR automatically. After you delete the Resource Explorer index in every Region in the account, you can use the IAM console to delete the SLR if you won't use Resource Explorer in the future. If you do delete the role and you then choose to access Resource Explorer again in at least one Amazon Web Services Region, Resource Explorer re-creates the service-linked role automatically.

Turning off Resource Explorer in one Amazon Web Services Region

You can turn off Resource Explorer in an Amazon Web Services Region by using the Amazon Web Services Management Console, by using commands in the Amazon Command Line Interface (Amazon CLI), or by using API operations in an Amazon SDK.

If you turn off Resource Explorer for a member account, and the member is in an organization wide view, it will be removed from the multi-account search results.

If your account includes a managed view (a view managed by an Amazon service), the managed view must be deleted before you can turn off Resource Explorer. Review Amazon managed views for instructions on removing a managed view from your account and prompting the managing service to delete the view.

If your account has streaming access enabled for an Amazon service, the streaming access must be removed before you can turn off Resource Explorer. To remove streaming access, follow the offboarding workflow for each service that has streaming access enabled. You can view which services have streaming access by using the ListStreamingAccessForServices API operation.

If you no longer want to support searching for resources in one or more of the Amazon Web Services Regions in your account, perform the steps in the following procedure.

Note

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.

Amazon Web Services Management Console
To delete the Resource Explorer index in an Amazon Web Services Region

  1. Open the Resource Explorer Settings page.

  2. In the Indexes section, select the check boxes next to the Amazon Web Services Regions with the indexes that you want to delete, and then choose Delete.

  3. On the Delete indexes page, verify that you selected only indexes that you want to delete. Type delete in the Confirm text box, and then choose Delete indexes.

    Resource Explorer displays a green banner at the top of the page to indicate success, or a red banner if there is an error with one or more of the selected Regions.

Amazon CLI
To delete the Resource Explorer index in an Amazon Web Services Region

If you no longer want to support searching for resources in one or more of the Amazon Web Services Regions in your account, run the following commands.

Run the following command for each Region with the indexes that you want to delete. You must run the command in the Region with the index you want to delete. The following example command deletes the Resource Explorer index in the US West (Oregon) (us-west-2).

$ aws resource-explorer-2 delete-index \
    --arn arn:aws:resource-explorer-2:us-west-2:123456789012:index/1a2b3c4d-5d6e-7f8a-9b0c-abcd22222222 \
    --region us-west-2
{
    "Arn": "arn:aws:resource-explorer-2:us-west-2:123456789012:index/1a2b3c4d-5d6e-7f8a-9b0c-abcd22222222",
    "State": "DELETING"
}

Because Resource Explorer performs some of the deletion cleanup work as asynchronous tasks in the background, the response might indicate that the operation is DELETING. This status indicates that the background processes are not yet complete. You can check for final completion by running the following command, and checking for the State to change to DELETED.

$ aws resource-explorer-2 get-index \
    --region us-west-2
{
    "Arn": "arn:aws:resource-explorer-2:us-west-2:123456789012:index/1a2b3c4d-5d6e-7f8a-9b0c-abcd11111111",
    "CreatedAt": "2022-07-12T18:59:10.503000+00:00",
    "LastUpdatedAt": "2022-07-13T18:41:58.799000+00:00",
    "ReplicatingFrom": [],
    "State": "DELETED",
    "Tags": {},
    "Type": "LOCAL"
}

Turning off Resource Explorer in all Amazon Web Services Regions

If you want to turn off Amazon Resource Explorer completely, perform the following procedure.

Note

Resource Explorer creates a service linked role named AWSServiceRoleForResourceExplorer in the account when you create an index in the first Amazon Web Services Region for an account. Resource Explorer does not automatically delete this service linked role. After you delete the Resource Explorer index in every Region, you can then use the IAM console to delete the role if you're sure you won't be using Resource Explorer again in the future. If you do delete the role and you then choose to start Resource Explorer in at least one Amazon Web Services Region, Resource Explorer recreates the service-linked role.

If your account includes a managed view (a view managed by an Amazon service), the managed view must be deleted before you can turn off Resource Explorer. Review Amazon managed views for instructions on removing a managed view from your account and prompting the managing service to delete the view.

If your account has streaming access enabled for an Amazon service, the streaming access must be removed before you can turn off Resource Explorer. To remove streaming access, follow the offboarding workflow for each service that has streaming access enabled. You can view which services have streaming access by using the ListStreamingAccessForServices API operation.

You can turn off Resource Explorer by using the Amazon Web Services Management Console, by using commands in the Amazon Command Line Interface (Amazon CLI), or by using API operations in an Amazon SDK.

Amazon Web Services Management Console

If you no longer want to support searching for resources in any Amazon Web Services Region in your Amazon Web Services account, perform the steps in the following procedure.

To turn off Resource Explorer in all Amazon Web Services Regions

  1. Open the Resource Explorer Settings page.

  2. In the Indexes section, select the check boxes next to all registered Amazon Web Services Regions, and then choose Delete.

    Tip

    You can check the box in the table header row next to Index to check the boxes for all Regions in a single step.

  3. On the Delete indexes page, verify that you want to delete all indexes. Type delete in the Confirm text box, and then choose Delete indexes.

    Resource Explorer displays a green banner at the top of the page to indicate success, or a red banner if there is an error with one or more of the selected Regions.

Amazon CLI
To turn off Resource Explorer in all Amazon Web Services Regions

If you no longer want to support searching for resources in any Amazon Web Services Regions in your account, run the following command to find the ARN of every index in each Amazon Web Services Region in which you previously turned on Resource Explorer.

$ aws resource-explorer-2 list-indexes --query Indexes[*].Arn[
"arn:aws:resource-explorer-2:us-east-1:123456789012:index/1a2b3c4d-5d6e-7f8a-9b0c-abcd11111111",
"arn:aws:resource-explorer-2:us-west-1:123456789012:index/1a2b3c4d-5d6e-7f8a-9b0c-abcd22222222",
"arn:aws:resource-explorer-2:us-west-2:123456789012:index/1a2b3c4d-5d6e-7f8a-9b0c-abcd33333333"
]

For each response, run the following command to delete the Resource Explorer index in that Region.

$ aws resource-explorer-2 delete-index \
    --arn arn:aws:resource-explorer-2:us-east-1:123456789012:index/1a2b3c4d-5d6e-7f8a-9b0c-abcd11111111 \
    --region us-east-1
{
    "Arn": "arn:aws:resource-explorer-2:us-east-1:123456789012:index/1a2b3c4d-5d6e-7f8a-9b0c-abcd11111111",
    "State": "DELETING"
}

Repeat the previous command in each additional Region.

Because Resource Explorer performs some of the cleanup as asynchronous tasks in the background, the response might indicate that the operation is DELETING. This status indicates that the background processes are not yet complete. You can check for final completion by running the following command, and checking for the status to change to DELETED.

$ aws resource-explorer-2 get-index \
    --region us-east-1
{
    "Arn": "arn:aws:resource-explorer-2:us-east-1:123456789012:index/1a2b3c4d-5d6e-7f8a-9b0c-abcd11111111",
    "CreatedAt": "2022-07-12T18:59:10.503000+00:00",
    "LastUpdatedAt": "2022-07-13T18:41:58.799000+00:00",
    "ReplicatingFrom": [],
    "State": "DELETED",
    "Tags": {},
    "Type": "LOCAL"
}