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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.

The DeleteBackup call returns instantly. The backup won't show up in later DescribeBackups calls.

The data in a deleted backup is also deleted and can't be recovered by any means.

Creating a Request

data DeleteBackup Source #

The request object for the DeleteBackup operation.

See: newDeleteBackup smart constructor.

Constructors

DeleteBackup'
Fields clientRequestToken :: Maybe Text A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the CLI or SDK. backupId :: Text The ID of the backup that you want to delete.

Instances

Instances details

ToJSON DeleteBackup Source #
Instance details Defined in Amazonka.FSx.DeleteBackup Methods toJSON :: DeleteBackup -> Value # toEncoding :: DeleteBackup -> Encoding # toJSONList :: [DeleteBackup] -> Value # toEncodingList :: [DeleteBackup] -> Encoding #
ToHeaders DeleteBackup Source #
Instance details Defined in Amazonka.FSx.DeleteBackup Methods toHeaders :: DeleteBackup -> [Header] #
ToPath DeleteBackup Source #
Instance details Defined in Amazonka.FSx.DeleteBackup Methods toPath :: DeleteBackup -> ByteString #
ToQuery DeleteBackup Source #
Instance details Defined in Amazonka.FSx.DeleteBackup Methods toQuery :: DeleteBackup -> QueryString #
AWSRequest DeleteBackup Source #
Instance details Defined in Amazonka.FSx.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.FSx.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.FSx.DeleteBackup Methods readsPrec :: Int -> ReadS DeleteBackup # readList :: ReadS [DeleteBackup] # readPrec :: ReadPrec DeleteBackup # readListPrec :: ReadPrec [DeleteBackup] #
Show DeleteBackup Source #
Instance details Defined in Amazonka.FSx.DeleteBackup Methods showsPrec :: Int -> DeleteBackup -> ShowS # show :: DeleteBackup -> String # showList :: [DeleteBackup] -> ShowS #
NFData DeleteBackup Source #
Instance details Defined in Amazonka.FSx.DeleteBackup Methods rnf :: DeleteBackup -> () #
Eq DeleteBackup Source #
Instance details Defined in Amazonka.FSx.DeleteBackup Methods (==) :: DeleteBackup -> DeleteBackup -> Bool # (/=) :: DeleteBackup -> DeleteBackup -> Bool #
Hashable DeleteBackup Source #
Instance details Defined in Amazonka.FSx.DeleteBackup Methods hashWithSalt :: Int -> DeleteBackup -> Int # hash :: DeleteBackup -> Int #
type AWSResponse DeleteBackup Source #
Instance details Defined in Amazonka.FSx.DeleteBackup type AWSResponse DeleteBackup = DeleteBackupResponse
type Rep DeleteBackup Source #
Instance details Defined in Amazonka.FSx.DeleteBackup type Rep DeleteBackup = D1 ('MetaData "DeleteBackup" "Amazonka.FSx.DeleteBackup" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DeleteBackup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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:

$sel:clientRequestToken:DeleteBackup', deleteBackup_clientRequestToken - A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the CLI or SDK.

DeleteBackup, deleteBackup_backupId - The ID of the backup that you want to delete.

Request Lenses

deleteBackup_clientRequestToken :: Lens' DeleteBackup (Maybe Text) Source #

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the CLI or SDK.

deleteBackup_backupId :: Lens' DeleteBackup Text Source #

The ID of the backup that you want to delete.

Destructuring the Response

data DeleteBackupResponse Source #

The response object for the DeleteBackup operation.

See: newDeleteBackupResponse smart constructor.

Constructors

DeleteBackupResponse'
Fields backupId :: Maybe Text The ID of the backup that was deleted. lifecycle :: Maybe BackupLifecycle The lifecycle status of the backup. If the `DeleteBackup` operation is successful, the status is `DELETED`. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DeleteBackupResponse Source #
Instance details Defined in Amazonka.FSx.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.FSx.DeleteBackup Methods readsPrec :: Int -> ReadS DeleteBackupResponse # readList :: ReadS [DeleteBackupResponse] # readPrec :: ReadPrec DeleteBackupResponse # readListPrec :: ReadPrec [DeleteBackupResponse] #
Show DeleteBackupResponse Source #
Instance details Defined in Amazonka.FSx.DeleteBackup Methods showsPrec :: Int -> DeleteBackupResponse -> ShowS # show :: DeleteBackupResponse -> String # showList :: [DeleteBackupResponse] -> ShowS #
NFData DeleteBackupResponse Source #
Instance details Defined in Amazonka.FSx.DeleteBackup Methods rnf :: DeleteBackupResponse -> () #
Eq DeleteBackupResponse Source #
Instance details Defined in Amazonka.FSx.DeleteBackup Methods (==) :: DeleteBackupResponse -> DeleteBackupResponse -> Bool # (/=) :: DeleteBackupResponse -> DeleteBackupResponse -> Bool #
type Rep DeleteBackupResponse Source #
Instance details Defined in Amazonka.FSx.DeleteBackup type Rep DeleteBackupResponse = D1 ('MetaData "DeleteBackupResponse" "Amazonka.FSx.DeleteBackup" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DeleteBackupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupLifecycle)) :: 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:

DeleteBackup, deleteBackupResponse_backupId - The ID of the backup that was deleted.

DeleteBackupResponse, deleteBackupResponse_lifecycle - The lifecycle status of the backup. If the DeleteBackup operation is successful, the status is DELETED.

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

Response Lenses

deleteBackupResponse_backupId :: Lens' DeleteBackupResponse (Maybe Text) Source #

The ID of the backup that was deleted.

deleteBackupResponse_lifecycle :: Lens' DeleteBackupResponse (Maybe BackupLifecycle) Source #

The lifecycle status of the backup. If the DeleteBackup operation is successful, the status is DELETED.

deleteBackupResponse_httpStatus :: Lens' DeleteBackupResponse Int Source #

The response's http status code.