:doc:`MemoryDB <../../memorydb>` / Client / delete_snapshot

***************
delete_snapshot
***************



.. py:method:: MemoryDB.Client.delete_snapshot(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteSnapshot>`_  


  **Request Syntax**
  ::

    response = client.delete_snapshot(
        SnapshotName='string'
    )
    
  :type SnapshotName: string
  :param SnapshotName: **[REQUIRED]** 

    The name of the snapshot to delete.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Snapshot': {
              'Name': 'string',
              'Status': 'string',
              'Source': 'string',
              'KmsKeyId': 'string',
              'ARN': 'string',
              'ClusterConfiguration': {
                  'Name': 'string',
                  'Description': 'string',
                  'NodeType': 'string',
                  'Engine': 'string',
                  'EngineVersion': 'string',
                  'MaintenanceWindow': 'string',
                  'TopicArn': 'string',
                  'Port': 123,
                  'ParameterGroupName': 'string',
                  'SubnetGroupName': 'string',
                  'VpcId': 'string',
                  'SnapshotRetentionLimit': 123,
                  'SnapshotWindow': 'string',
                  'NumShards': 123,
                  'Shards': [
                      {
                          'Name': 'string',
                          'Configuration': {
                              'Slots': 'string',
                              'ReplicaCount': 123
                          },
                          'Size': 'string',
                          'SnapshotCreationTime': datetime(2015, 1, 1)
                      },
                  ],
                  'MultiRegionParameterGroupName': 'string',
                  'MultiRegionClusterName': 'string'
              },
              'DataTiering': 'true'|'false'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Snapshot** *(dict) --* 

        The snapshot object that has been deleted.

        
        

        - **Name** *(string) --* 

          The name of the snapshot

          
        

        - **Status** *(string) --* 

          The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

          
        

        - **Source** *(string) --* 

          Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

          
        

        - **KmsKeyId** *(string) --* 

          The ID of the KMS key used to encrypt the snapshot.

          
        

        - **ARN** *(string) --* 

          The ARN (Amazon Resource Name) of the snapshot.

          
        

        - **ClusterConfiguration** *(dict) --* 

          The configuration of the cluster from which the snapshot was taken

          
          

          - **Name** *(string) --* 

            The name of the cluster

            
          

          - **Description** *(string) --* 

            The description of the cluster configuration

            
          

          - **NodeType** *(string) --* 

            The node type used for the cluster

            
          

          - **Engine** *(string) --* 

            The name of the engine used by the cluster configuration.

            
          

          - **EngineVersion** *(string) --* 

            The Redis OSS engine version used by the cluster

            
          

          - **MaintenanceWindow** *(string) --* 

            The specified maintenance window for the cluster

            
          

          - **TopicArn** *(string) --* 

            The Amazon Resource Name (ARN) of the SNS notification topic for the cluster

            
          

          - **Port** *(integer) --* 

            The port used by the cluster

            
          

          - **ParameterGroupName** *(string) --* 

            The name of parameter group used by the cluster

            
          

          - **SubnetGroupName** *(string) --* 

            The name of the subnet group used by the cluster

            
          

          - **VpcId** *(string) --* 

            The ID of the VPC the cluster belongs to

            
          

          - **SnapshotRetentionLimit** *(integer) --* 

            The snapshot retention limit set by the cluster

            
          

          - **SnapshotWindow** *(string) --* 

            The snapshot window set by the cluster

            
          

          - **NumShards** *(integer) --* 

            The number of shards in the cluster

            
          

          - **Shards** *(list) --* 

            The list of shards in the cluster

            
            

            - *(dict) --* 

              Provides details of a shard in a snapshot

              
              

              - **Name** *(string) --* 

                The name of the shard

                
              

              - **Configuration** *(dict) --* 

                The configuration details of the shard

                
                

                - **Slots** *(string) --* 

                  A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

                  
                

                - **ReplicaCount** *(integer) --* 

                  The number of read replica nodes in this shard.

                  
            
              

              - **Size** *(string) --* 

                The size of the shard's snapshot

                
              

              - **SnapshotCreationTime** *(datetime) --* 

                The date and time that the shard's snapshot was created

                
          
        
          

          - **MultiRegionParameterGroupName** *(string) --* 

            The name of the multi-Region parameter group associated with the cluster configuration.

            
          

          - **MultiRegionClusterName** *(string) --* 

            The name for the multi-Region cluster associated with the cluster configuration.

            
      
        

        - **DataTiering** *(string) --* 

          Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see `Data tiering <https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html>`__.

          
    
  
  **Exceptions**
  
  *   :py:class:`MemoryDB.Client.exceptions.SnapshotNotFoundFault`

  
  *   :py:class:`MemoryDB.Client.exceptions.InvalidSnapshotStateFault`

  
  *   :py:class:`MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault`

  
  *   :py:class:`MemoryDB.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`MemoryDB.Client.exceptions.InvalidParameterCombinationException`

  