ResourceExplorer / Client / delete_index

delete_index#

ResourceExplorer.Client.delete_index(**kwargs)#

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.

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.

Request Syntax

response = client.delete_index(
    Arn='string'
)

Parameters:

Arn (string) –

[REQUIRED]

The Amazon resource name (ARN) of the index that you want to delete.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'LastUpdatedAt': datetime(2015, 1, 1),
    'State': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'UPDATING'
}

Response Structure

(dict) –
- Arn (string) –
  
  The Amazon resource name (ARN) of the index that you successfully started the deletion process.
  
  Note
  This operation is asynchronous. To check its status, call the GetIndex operation.
- LastUpdatedAt (datetime) –
  
  The date and time when you last updated this index.
- State (string) –
  
  Indicates the current state of the index.

Exceptions

ResourceExplorer.Client.exceptions.ResourceNotFoundException
ResourceExplorer.Client.exceptions.InternalServerException
ResourceExplorer.Client.exceptions.ValidationException
ResourceExplorer.Client.exceptions.ThrottlingException
ResourceExplorer.Client.exceptions.AccessDeniedException