StorageGateway / Client / delete_snapshot_schedule

delete_snapshot_schedule¶

StorageGateway.Client.delete_snapshot_schedule(**kwargs)¶

Deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types.

Note

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Request Syntax

response = client.delete_snapshot_schedule(
    VolumeARN='string'
)

Parameters:

VolumeARN (string) –

[REQUIRED]

The volume which snapshot schedule to delete.

Return type:

dict

Returns:

Response Syntax

{
    'VolumeARN': 'string'
}

Response Structure

(dict) –
- VolumeARN (string) –
  
  The volume which snapshot schedule was deleted.

Exceptions

StorageGateway.Client.exceptions.InvalidGatewayRequestException
StorageGateway.Client.exceptions.InternalServerError

Examples

This action enables you to delete a snapshot schedule for a volume.

response = client.delete_snapshot_schedule(
    VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)

print(response)

Expected Output:

{
    'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
    'ResponseMetadata': {
        '...': '...',
    },
}