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.QLDB.DeleteLedger

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes a ledger and all of its contents. This action is irreversible.

If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false.

Synopsis

data DeleteLedger = DeleteLedger' {
- name :: Text
}
newDeleteLedger :: Text -> DeleteLedger
deleteLedger_name :: Lens' DeleteLedger Text
data DeleteLedgerResponse = DeleteLedgerResponse' {
}
newDeleteLedgerResponse :: DeleteLedgerResponse

Creating a Request

data DeleteLedger Source #

See: newDeleteLedger smart constructor.

Constructors

DeleteLedger'
Fields name :: Text The name of the ledger that you want to delete.

Instances

Instances details

ToHeaders DeleteLedger Source #
Instance details Defined in Amazonka.QLDB.DeleteLedger Methods toHeaders :: DeleteLedger -> [Header] #
ToPath DeleteLedger Source #
Instance details Defined in Amazonka.QLDB.DeleteLedger Methods toPath :: DeleteLedger -> ByteString #
ToQuery DeleteLedger Source #
Instance details Defined in Amazonka.QLDB.DeleteLedger Methods toQuery :: DeleteLedger -> QueryString #
AWSRequest DeleteLedger Source #
Instance details Defined in Amazonka.QLDB.DeleteLedger Associated Types type AWSResponse DeleteLedger # Methods request :: (Service -> Service) -> DeleteLedger -> Request DeleteLedger # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteLedger -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteLedger))) #
Generic DeleteLedger Source #
Instance details Defined in Amazonka.QLDB.DeleteLedger Associated Types type Rep DeleteLedger :: Type -> Type # Methods from :: DeleteLedger -> Rep DeleteLedger x # to :: Rep DeleteLedger x -> DeleteLedger #
Read DeleteLedger Source #
Instance details Defined in Amazonka.QLDB.DeleteLedger Methods readsPrec :: Int -> ReadS DeleteLedger # readList :: ReadS [DeleteLedger] # readPrec :: ReadPrec DeleteLedger # readListPrec :: ReadPrec [DeleteLedger] #
Show DeleteLedger Source #
Instance details Defined in Amazonka.QLDB.DeleteLedger Methods showsPrec :: Int -> DeleteLedger -> ShowS # show :: DeleteLedger -> String # showList :: [DeleteLedger] -> ShowS #
NFData DeleteLedger Source #
Instance details Defined in Amazonka.QLDB.DeleteLedger Methods rnf :: DeleteLedger -> () #
Eq DeleteLedger Source #
Instance details Defined in Amazonka.QLDB.DeleteLedger Methods (==) :: DeleteLedger -> DeleteLedger -> Bool # (/=) :: DeleteLedger -> DeleteLedger -> Bool #
Hashable DeleteLedger Source #
Instance details Defined in Amazonka.QLDB.DeleteLedger Methods hashWithSalt :: Int -> DeleteLedger -> Int # hash :: DeleteLedger -> Int #
type AWSResponse DeleteLedger Source #
Instance details Defined in Amazonka.QLDB.DeleteLedger type AWSResponse DeleteLedger = DeleteLedgerResponse
type Rep DeleteLedger Source #
Instance details Defined in Amazonka.QLDB.DeleteLedger type Rep DeleteLedger = D1 ('MetaData "DeleteLedger" "Amazonka.QLDB.DeleteLedger" "amazonka-qldb-2.0-GHDpAUfL5Gp5EFIat3BpxK" 'False) (C1 ('MetaCons "DeleteLedger'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteLedger Source #

Arguments

:: Text	`DeleteLedger`
-> DeleteLedger

Create a value of DeleteLedger 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:

DeleteLedger, deleteLedger_name - The name of the ledger that you want to delete.

Request Lenses

deleteLedger_name :: Lens' DeleteLedger Text Source #

The name of the ledger that you want to delete.

Destructuring the Response

data DeleteLedgerResponse Source #

See: newDeleteLedgerResponse smart constructor.

Constructors

DeleteLedgerResponse'

Instances

Instances details

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

newDeleteLedgerResponse :: DeleteLedgerResponse Source #

Create a value of DeleteLedgerResponse with all optional fields omitted.

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