delete_snapshot_schedule ¶

def delete_snapshot_schedule(
    self,
    volume_arn: "capo_storage_gateway.types.volume_arn.VolumeARN",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.delete_snapshot_schedule_output.DeleteSnapshotScheduleOutput":
    """<p>Deletes a snapshot of a volume.</p> <p>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 <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html">Backing up your volumes</a>. In the <code>DeleteSnapshotSchedule</code> request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types.</p> <note> <p>To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>.</p> </note>

    Args:
        volume_arn: <p>The volume which snapshot schedule to delete.</p>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To delete a snapshot of a volume
        This action enables you to delete a snapshot schedule for a volume.

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

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.delete_snapshot_schedule_input.DeleteSnapshotScheduleInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.delete_snapshot_schedule_output.DeleteSnapshotScheduleOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.delete_snapshot_schedule

        output, http_response = (
            capo_storage_gateway._operations.storage_gateway_20130630.delete_snapshot_schedule.delete_snapshot_schedule(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteSnapshotSchedule")
    )
    input_: capo_storage_gateway.types.delete_snapshot_schedule_input.DeleteSnapshotScheduleInput = {
        "volume_arn": volume_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output