OpsWorksCM / Client / delete_backup

delete_backup#

OpsWorksCM.Client.delete_backup(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_backup(
    BackupId='string'
)
Parameters:

BackupId (string) –

[REQUIRED]

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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • OpsWorksCM.Client.exceptions.InvalidStateException

  • OpsWorksCM.Client.exceptions.ResourceNotFoundException

  • OpsWorksCM.Client.exceptions.ValidationException