AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

This operation is valid for Redis only.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DeleteSnapshotAsync.

Namespace: Amazon.ElastiCache
Assembly: AWSSDK.ElastiCache.dll
Version: 3.x.y.z

Syntax

C#
public virtual DeleteSnapshotResponse DeleteSnapshot(
         DeleteSnapshotRequest request
)
Parameters
request
Type: Amazon.ElastiCache.Model.DeleteSnapshotRequest

Container for the necessary parameters to execute the DeleteSnapshot service method.

Return Value
The response from the DeleteSnapshot service method, as returned by ElastiCache.

Exceptions

ExceptionCondition
InvalidParameterCombinationException Two or more incompatible parameters were specified.
InvalidParameterValueException The value for a parameter is invalid.
InvalidSnapshotStateException The current state of the snapshot does not allow the requested operation to occur.
SnapshotNotFoundException The requested snapshot name does not refer to an existing snapshot.

Examples

Deletes the Redis snapshot snapshot-20160822.

DeleteSnapshot


var response = client.DeleteSnapshot(new DeleteSnapshotRequest 
{
    SnapshotName = "snapshot-20161212"
});

Snapshot snapshot = response.Snapshot;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also