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.Kendra.DeleteIndex

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.

Synopsis

data DeleteIndex = DeleteIndex' {
- id :: Text
}
newDeleteIndex :: Text -> DeleteIndex
deleteIndex_id :: Lens' DeleteIndex Text
data DeleteIndexResponse = DeleteIndexResponse' {
}
newDeleteIndexResponse :: DeleteIndexResponse

Creating a Request

data DeleteIndex Source #

See: newDeleteIndex smart constructor.

Constructors

DeleteIndex'
Fields id :: Text The identifier of the index you want to delete.

Instances

Instances details

ToJSON DeleteIndex Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods toJSON :: DeleteIndex -> Value # toEncoding :: DeleteIndex -> Encoding # toJSONList :: [DeleteIndex] -> Value # toEncodingList :: [DeleteIndex] -> Encoding #
ToHeaders DeleteIndex Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods toHeaders :: DeleteIndex -> [Header] #
ToPath DeleteIndex Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods toPath :: DeleteIndex -> ByteString #
ToQuery DeleteIndex Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods toQuery :: DeleteIndex -> QueryString #
AWSRequest DeleteIndex Source #
Instance details Defined in Amazonka.Kendra.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 Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Associated Types type Rep DeleteIndex :: Type -> Type # Methods from :: DeleteIndex -> Rep DeleteIndex x # to :: Rep DeleteIndex x -> DeleteIndex #
Read DeleteIndex Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods readsPrec :: Int -> ReadS DeleteIndex # readList :: ReadS [DeleteIndex] # readPrec :: ReadPrec DeleteIndex # readListPrec :: ReadPrec [DeleteIndex] #
Show DeleteIndex Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods showsPrec :: Int -> DeleteIndex -> ShowS # show :: DeleteIndex -> String # showList :: [DeleteIndex] -> ShowS #
NFData DeleteIndex Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods rnf :: DeleteIndex -> () #
Eq DeleteIndex Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods (==) :: DeleteIndex -> DeleteIndex -> Bool # (/=) :: DeleteIndex -> DeleteIndex -> Bool #
Hashable DeleteIndex Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods hashWithSalt :: Int -> DeleteIndex -> Int # hash :: DeleteIndex -> Int #
type AWSResponse DeleteIndex Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex type AWSResponse DeleteIndex = DeleteIndexResponse
type Rep DeleteIndex Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex type Rep DeleteIndex = D1 ('MetaData "DeleteIndex" "Amazonka.Kendra.DeleteIndex" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteIndex'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteIndex Source #

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_id - The identifier of the index you want to delete.

Request Lenses

deleteIndex_id :: Lens' DeleteIndex Text Source #

The identifier of the index you want to delete.

Destructuring the Response

data DeleteIndexResponse Source #

See: newDeleteIndexResponse smart constructor.

Constructors

DeleteIndexResponse'

Instances

Instances details

Generic DeleteIndexResponse Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Associated Types type Rep DeleteIndexResponse :: Type -> Type # Methods from :: DeleteIndexResponse -> Rep DeleteIndexResponse x # to :: Rep DeleteIndexResponse x -> DeleteIndexResponse #
Read DeleteIndexResponse Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods readsPrec :: Int -> ReadS DeleteIndexResponse # readList :: ReadS [DeleteIndexResponse] # readPrec :: ReadPrec DeleteIndexResponse # readListPrec :: ReadPrec [DeleteIndexResponse] #
Show DeleteIndexResponse Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods showsPrec :: Int -> DeleteIndexResponse -> ShowS # show :: DeleteIndexResponse -> String # showList :: [DeleteIndexResponse] -> ShowS #
NFData DeleteIndexResponse Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods rnf :: DeleteIndexResponse -> () #
Eq DeleteIndexResponse Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex Methods (==) :: DeleteIndexResponse -> DeleteIndexResponse -> Bool # (/=) :: DeleteIndexResponse -> DeleteIndexResponse -> Bool #
type Rep DeleteIndexResponse Source #
Instance details Defined in Amazonka.Kendra.DeleteIndex type Rep DeleteIndexResponse = D1 ('MetaData "DeleteIndexResponse" "Amazonka.Kendra.DeleteIndex" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DeleteIndexResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteIndexResponse :: DeleteIndexResponse Source #

Create a value of DeleteIndexResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.