:doc:`StorageGateway <../../storagegateway>` / Client / delete_snapshot_schedule

************************
delete_snapshot_schedule
************************



.. py:method:: 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 <https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html>`__. 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 <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html>`__ in the *Amazon Elastic Compute Cloud API Reference*.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteSnapshotSchedule>`_  


  **Request Syntax**
  ::

    response = client.delete_snapshot_schedule(
        VolumeARN='string'
    )
    
  :type VolumeARN: string
  :param VolumeARN: **[REQUIRED]** 

    The volume which snapshot schedule to delete.

    

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

    
    ::

      {
          'VolumeARN': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **VolumeARN** *(string) --* 

        The volume which snapshot schedule was deleted.

        
  
  **Exceptions**
  
  *   :py:class:`StorageGateway.Client.exceptions.InvalidGatewayRequestException`

  
  *   :py:class:`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': {
            '...': '...',
        },
    }

  