start_remote_delete ¶

def start_remote_delete(
    self,
    connector_id: "capo_transfer.types.connector_id.ConnectorId",
    delete_path: "capo_transfer.types.file_path.FilePath",
    *,
    config_overrides: Optional[TransferClientConfig] = None,
) -> "capo_transfer.types.start_remote_delete_response.StartRemoteDeleteResponse":
    """<p>Deletes a file or directory on the remote SFTP server.</p>

    Args:
        connector_id: <p>The unique identifier for the connector.</p>
        delete_path: <p>The absolute path of the file or directory to delete. You can only specify one path per call to this operation.</p>

    Raises:
        capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
        capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
        capo_transfer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
        capo_transfer.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_transfer.types.start_remote_delete_request.StartRemoteDeleteRequest]",
    ) -> OperationResponse[
        "capo_transfer.types.start_remote_delete_response.StartRemoteDeleteResponse"
    ]:
        import capo_transfer._operations.transfer_service.start_remote_delete

        output, http_response = (
            capo_transfer._operations.transfer_service.start_remote_delete.start_remote_delete(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartRemoteDelete")
    )
    input_: capo_transfer.types.start_remote_delete_request.StartRemoteDeleteRequest = {
        "connector_id": connector_id,
        "delete_path": delete_path,
    }

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