Request Parameters Response Elements Errors Examples See Also

DeleteSnapshot

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.

Note

This operation is valid for Valkey or Redis OSS only.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

SnapshotName

The name of the snapshot to be deleted.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

Snapshot

Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.

Type: Snapshot object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterCombination

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

InvalidSnapshotState

The current state of the snapshot does not allow the requested operation to occur.

HTTP Status Code: 400

SnapshotNotFoundFault

The requested snapshot name does not refer to an existing snapshot.

HTTP Status Code: 404

Examples

DeleteSnapshot

This example illustrates one usage of DeleteSnapshot.

Sample Request


https://elasticache.us-west-2.amazonaws.com/
   ?Action=DeleteSnapshot
   &SnapshotName=my-manual-snapshot
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>

Sample Response


<DeleteSnapshotResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> 
   <DeleteSnapshotResult> 
      <Snapshot> 
         <CacheClusterId>my-redis-primary</CacheClusterId> 
         <Port>6379</Port> 
         <CacheNodeType>cache.m1.small</CacheNodeType> 
         <CacheParameterGroupName>default.redis2.8</CacheParameterGroupName> 
         <Engine>redis</Engine> 
         <PreferredAvailabilityZone>us-west-2c</PreferredAvailabilityZone> 
         <CacheClusterCreateTime>2015-02-02T18:46:57.972Z</CacheClusterCreateTime> 
         <EngineVersion>2.8.6</EngineVersion> 
         <SnapshotSource>manual</SnapshotSource> 
         <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> 
         <PreferredMaintenanceWindow>wed:09:00-wed:10:00</PreferredMaintenanceWindow> 
         <SnapshotName>my-manual-snapshot</SnapshotName> 
         <SnapshotRetentionLimit>5</SnapshotRetentionLimit> 
         <NodeSnapshots> 
            <NodeSnapshot> 
               <SnapshotCreateTime>2015-02-02T18:54:12Z</SnapshotCreateTime> 
               <CacheNodeCreateTime>2015-02-02T18:46:57.972Z</CacheNodeCreateTime> 
               <CacheNodeId>0001</CacheNodeId> 
               <CacheSize>3 MB</CacheSize> 
            </NodeSnapshot> 
         </NodeSnapshots> 
         <SnapshotStatus>deleting</SnapshotStatus> 
         <NumCacheNodes>1</NumCacheNodes> 
         <SnapshotWindow>07:30-08:30</SnapshotWindow> 
      </Snapshot> 
   </DeleteSnapshotResult> 
   <ResponseMetadata> 
      <RequestId>694d7017-b9d2-11e3-8a16-7978bb24ffdf</RequestId> 
   </ResponseMetadata> 
</DeleteSnapshotResponse>