Amazonka.ResourceExplorer2.DeleteIndex

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.

Creating a Request

data DeleteIndex

See: newDeleteIndex smart constructor.

Constructors

DeleteIndex'

Fields

• arn :: Text

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

Instances

ToJSON DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

toJSON :: DeleteIndex -> Value

toEncoding :: DeleteIndex -> Encoding

toJSONList :: [DeleteIndex] -> Value

toEncodingList :: [DeleteIndex] -> Encoding

ToHeaders DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

toHeaders :: DeleteIndex -> [Header]

ToPath DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

toPath :: DeleteIndex -> ByteString

ToQuery DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

toQuery :: DeleteIndex -> QueryString

AWSRequest DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Associated Types

type AWSResponse DeleteIndex

Methods

request :: (Service -> Service) -> DeleteIndex -> Request DeleteIndex

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteIndex -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteIndex)))

Generic DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Associated Types

type Rep DeleteIndex :: Type -> Type

Methods

from :: DeleteIndex -> Rep DeleteIndex x

to :: Rep DeleteIndex x -> DeleteIndex

Read DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

readsPrec :: Int -> ReadS DeleteIndex

readList :: ReadS [DeleteIndex]

readPrec :: ReadPrec DeleteIndex

readListPrec :: ReadPrec [DeleteIndex]

Show DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

showsPrec :: Int -> DeleteIndex -> ShowS

show :: DeleteIndex -> String

showList :: [DeleteIndex] -> ShowS

NFData DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

rnf :: DeleteIndex -> ()

Eq DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

(==) :: DeleteIndex -> DeleteIndex -> Bool

(/=) :: DeleteIndex -> DeleteIndex -> Bool

Hashable DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

hashWithSalt :: Int -> DeleteIndex -> Int

hash :: DeleteIndex -> Int

type AWSResponse DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

type AWSResponse DeleteIndex = DeleteIndexResponse

type Rep DeleteIndex

Defined in Amazonka.ResourceExplorer2.DeleteIndex

type Rep DeleteIndex = D1 ('MetaData "DeleteIndex" "Amazonka.ResourceExplorer2.DeleteIndex" "amazonka-resource-explorer-v2-2.0-DYDynTzMYCcKX3QLWjH6Yt" 'False) (C1 ('MetaCons "DeleteIndex'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteIndex

Arguments

:: Text

DeleteIndex

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

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

Destructuring the Response

data DeleteIndexResponse

See: newDeleteIndexResponse smart constructor.

Constructors

DeleteIndexResponse'

Fields

• arn :: Maybe Text

  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.

• lastUpdatedAt :: Maybe ISO8601

  The date and time when you last updated this index.

• state :: Maybe IndexState

  Indicates the current state of the index.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteIndexResponse

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Associated Types

type Rep DeleteIndexResponse :: Type -> Type

Methods

from :: DeleteIndexResponse -> Rep DeleteIndexResponse x

to :: Rep DeleteIndexResponse x -> DeleteIndexResponse

Read DeleteIndexResponse

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

readsPrec :: Int -> ReadS DeleteIndexResponse

readList :: ReadS [DeleteIndexResponse]

readPrec :: ReadPrec DeleteIndexResponse

readListPrec :: ReadPrec [DeleteIndexResponse]

Show DeleteIndexResponse

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

showsPrec :: Int -> DeleteIndexResponse -> ShowS

show :: DeleteIndexResponse -> String

showList :: [DeleteIndexResponse] -> ShowS

NFData DeleteIndexResponse

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

rnf :: DeleteIndexResponse -> ()

Eq DeleteIndexResponse

Defined in Amazonka.ResourceExplorer2.DeleteIndex

Methods

(==) :: DeleteIndexResponse -> DeleteIndexResponse -> Bool

(/=) :: DeleteIndexResponse -> DeleteIndexResponse -> Bool

type Rep DeleteIndexResponse

Defined in Amazonka.ResourceExplorer2.DeleteIndex

type Rep DeleteIndexResponse = D1 ('MetaData "DeleteIndexResponse" "Amazonka.ResourceExplorer2.DeleteIndex" "amazonka-resource-explorer-v2-2.0-DYDynTzMYCcKX3QLWjH6Yt" 'False) (C1 ('MetaCons "DeleteIndexResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDeleteIndexResponse

Arguments

:: Int

$sel:httpStatus:DeleteIndexResponse'

-> 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)

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)

The date and time when you last updated this index.

deleteIndexResponse_state :: Lens' DeleteIndexResponse (Maybe IndexState)

Indicates the current state of the index.

deleteIndexResponse_httpStatus :: Lens' DeleteIndexResponse Int

The response's http status code.