amazonka-backup-2.0: Amazon Backup SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Backup.DeleteRecoveryPoint

Description

Deletes the recovery point specified by a recovery point ID.

If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.

When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state.

EXPIRED recovery points can be deleted with this API once the IAM role has the iam:CreateServiceLinkedRole action. To learn more about adding this role, see Troubleshooting manual deletions.

If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an EXPIRED state.

Synopsis

Creating a Request

data DeleteRecoveryPoint Source #

See: newDeleteRecoveryPoint smart constructor.

Constructors

DeleteRecoveryPoint' 

Fields

  • backupVaultName :: Text

    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

  • recoveryPointArn :: Text

    An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Instances

Instances details
ToHeaders DeleteRecoveryPoint Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

ToPath DeleteRecoveryPoint Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

ToQuery DeleteRecoveryPoint Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

AWSRequest DeleteRecoveryPoint Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

Associated Types

type AWSResponse DeleteRecoveryPoint #

Generic DeleteRecoveryPoint Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

Associated Types

type Rep DeleteRecoveryPoint :: Type -> Type #

Read DeleteRecoveryPoint Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

Show DeleteRecoveryPoint Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

NFData DeleteRecoveryPoint Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

Methods

rnf :: DeleteRecoveryPoint -> () #

Eq DeleteRecoveryPoint Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

Hashable DeleteRecoveryPoint Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

type AWSResponse DeleteRecoveryPoint Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

type Rep DeleteRecoveryPoint Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

type Rep DeleteRecoveryPoint = D1 ('MetaData "DeleteRecoveryPoint" "Amazonka.Backup.DeleteRecoveryPoint" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DeleteRecoveryPoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupVaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "recoveryPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteRecoveryPoint Source #

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

DeleteRecoveryPoint, deleteRecoveryPoint_backupVaultName - The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

DeleteRecoveryPoint, deleteRecoveryPoint_recoveryPointArn - An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Request Lenses

deleteRecoveryPoint_backupVaultName :: Lens' DeleteRecoveryPoint Text Source #

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

deleteRecoveryPoint_recoveryPointArn :: Lens' DeleteRecoveryPoint Text Source #

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Destructuring the Response

data DeleteRecoveryPointResponse Source #

See: newDeleteRecoveryPointResponse smart constructor.

Instances

Instances details
Generic DeleteRecoveryPointResponse Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

Associated Types

type Rep DeleteRecoveryPointResponse :: Type -> Type #

Read DeleteRecoveryPointResponse Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

Show DeleteRecoveryPointResponse Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

NFData DeleteRecoveryPointResponse Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

Eq DeleteRecoveryPointResponse Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

type Rep DeleteRecoveryPointResponse Source # 
Instance details

Defined in Amazonka.Backup.DeleteRecoveryPoint

type Rep DeleteRecoveryPointResponse = D1 ('MetaData "DeleteRecoveryPointResponse" "Amazonka.Backup.DeleteRecoveryPoint" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DeleteRecoveryPointResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteRecoveryPointResponse :: DeleteRecoveryPointResponse Source #

Create a value of DeleteRecoveryPointResponse with all optional fields omitted.

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