| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ResourceExplorer2.DeleteIndex
Description
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.
Synopsis
- data DeleteIndex = DeleteIndex' {}
- newDeleteIndex :: Text -> DeleteIndex
- deleteIndex_arn :: Lens' DeleteIndex Text
- data DeleteIndexResponse = DeleteIndexResponse' {
- arn :: Maybe Text
- lastUpdatedAt :: Maybe ISO8601
- state :: Maybe IndexState
- httpStatus :: Int
- newDeleteIndexResponse :: Int -> DeleteIndexResponse
- deleteIndexResponse_arn :: Lens' DeleteIndexResponse (Maybe Text)
- deleteIndexResponse_lastUpdatedAt :: Lens' DeleteIndexResponse (Maybe UTCTime)
- deleteIndexResponse_state :: Lens' DeleteIndexResponse (Maybe IndexState)
- deleteIndexResponse_httpStatus :: Lens' DeleteIndexResponse Int
Creating a Request
data DeleteIndex Source #
See: newDeleteIndex smart constructor.
Constructors
| DeleteIndex' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DeleteIndex |
Create a value of DeleteIndex with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteIndex, deleteIndex_arn - The
Amazon resource name (ARN)
of the index that you want to delete.
Request Lenses
deleteIndex_arn :: Lens' DeleteIndex Text Source #
The Amazon resource name (ARN) of the index that you want to delete.
Destructuring the Response
data DeleteIndexResponse Source #
See: newDeleteIndexResponse smart constructor.
Constructors
| DeleteIndexResponse' | |
Fields
| |
Instances
newDeleteIndexResponse Source #
Arguments
| :: Int | |
| -> DeleteIndexResponse |
Create a value of DeleteIndexResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteIndex, deleteIndexResponse_arn - The
Amazon resource name (ARN)
of the index that you successfully started the deletion process.
This operation is asynchronous. To check its status, call the GetIndex operation.
DeleteIndexResponse, deleteIndexResponse_lastUpdatedAt - The date and time when you last updated this index.
$sel:state:DeleteIndexResponse', deleteIndexResponse_state - Indicates the current state of the index.
$sel:httpStatus:DeleteIndexResponse', deleteIndexResponse_httpStatus - The response's http status code.
Response Lenses
deleteIndexResponse_arn :: Lens' DeleteIndexResponse (Maybe Text) Source #
The Amazon resource name (ARN) of the index that you successfully started the deletion process.
This operation is asynchronous. To check its status, call the GetIndex operation.
deleteIndexResponse_lastUpdatedAt :: Lens' DeleteIndexResponse (Maybe UTCTime) Source #
The date and time when you last updated this index.
deleteIndexResponse_state :: Lens' DeleteIndexResponse (Maybe IndexState) Source #
Indicates the current state of the index.
deleteIndexResponse_httpStatus :: Lens' DeleteIndexResponse Int Source #
The response's http status code.