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.OpsWorksCM.DeleteBackup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.

An InvalidStateException is thrown when a backup deletion is already in progress. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

Synopsis

Creating a Request

data DeleteBackup Source #

See: newDeleteBackup smart constructor.

Constructors

DeleteBackup'
Fields backupId :: Text The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format `ServerName-yyyyMMddHHmmssSSS`.

Instances

Instances details

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

newDeleteBackup Source #

Arguments

:: Text	`DeleteBackup`
-> DeleteBackup

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

DeleteBackup, deleteBackup_backupId - The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS.

Request Lenses

deleteBackup_backupId :: Lens' DeleteBackup Text Source #

The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS.

Destructuring the Response

data DeleteBackupResponse Source #

See: newDeleteBackupResponse smart constructor.

Constructors

DeleteBackupResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DeleteBackupResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DeleteBackup Associated Types type Rep DeleteBackupResponse :: Type -> Type # Methods from :: DeleteBackupResponse -> Rep DeleteBackupResponse x # to :: Rep DeleteBackupResponse x -> DeleteBackupResponse #
Read DeleteBackupResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DeleteBackup Methods readsPrec :: Int -> ReadS DeleteBackupResponse # readList :: ReadS [DeleteBackupResponse] # readPrec :: ReadPrec DeleteBackupResponse # readListPrec :: ReadPrec [DeleteBackupResponse] #
Show DeleteBackupResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DeleteBackup Methods showsPrec :: Int -> DeleteBackupResponse -> ShowS # show :: DeleteBackupResponse -> String # showList :: [DeleteBackupResponse] -> ShowS #
NFData DeleteBackupResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DeleteBackup Methods rnf :: DeleteBackupResponse -> () #
Eq DeleteBackupResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DeleteBackup Methods (==) :: DeleteBackupResponse -> DeleteBackupResponse -> Bool # (/=) :: DeleteBackupResponse -> DeleteBackupResponse -> Bool #
type Rep DeleteBackupResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DeleteBackup type Rep DeleteBackupResponse = D1 ('MetaData "DeleteBackupResponse" "Amazonka.OpsWorksCM.DeleteBackup" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "DeleteBackupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteBackupResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteBackupResponse'`
-> DeleteBackupResponse

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

$sel:httpStatus:DeleteBackupResponse', deleteBackupResponse_httpStatus - The response's http status code.

Response Lenses

deleteBackupResponse_httpStatus :: Lens' DeleteBackupResponse Int Source #

The response's http status code.